JSON:API
Official docs outline
11 sections- Document structure
Top-level members data, errors, meta, links and included.
- Resource objects
id, type, attributes, relationships and links.
- Compound documents
Full linkage and the included array.
- Fetching resources
GET semantics for resource collections and individual resources.
- Inclusion of related resources
The include query parameter.
- Sparse fieldsets
The fields[TYPE] query parameter.
- Sorting and pagination
sort parameter and pagination links.
- Creating resources
POST semantics, 201 Created and client-generated IDs.
- Updating resources
PATCH semantics for attributes and relationships.
- Error objects
status, code, title, detail and source members.
- 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.