Extra Credit

JSON:API

Official docs outline

11 sections
  1. Document structure

    Top-level members data, errors, meta, links and included.

  2. Resource objects

    id, type, attributes, relationships and links.

  3. Compound documents

    Full linkage and the included array.

  4. Fetching resources

    GET semantics for resource collections and individual resources.

  5. Inclusion of related resources

    The include query parameter.

  6. Sparse fieldsets

    The fields[TYPE] query parameter.

  7. Sorting and pagination

    sort parameter and pagination links.

  8. Creating resources

    POST semantics, 201 Created and client-generated IDs.

  9. Updating resources

    PATCH semantics for attributes and relationships.

  10. Error objects

    status, code, title, detail and source members.

  11. Content negotiation

    Media type parameters and 415/406 behavior.

Each section links to the official page. Titles and summaries by Extra Credit; the docs belong to their authors.

All 29