JSON-API-SPEC

Yehuda Katz REST JSON structure spec.

Definition

JSON:API v1.1 (published October 2022) includes: top-level objects data/errors/meta/jsonapi/links/included, resource objects (type, id, attributes, relationships, links, meta), sparse fieldsets (?fields[type]=name), standardised filtering, pagination, sorting. Content-Type application/vnd.api+json. Adopts JSON Schema. Implementations: Ember Data, Yii2 framework, jsonapi-ruby, jsonapi-server-node.

Origin

JSON:API v1.0 published 29 May 2015 by Yehuda Katz and Steve Klabnik ; v1.1 published 19 October 2022.

Example in context

A JSON:API API returns data:{type:orders,id:42,attributes:{total:99},relationships:{customer:{data:{type:customers,id:7}}}},included:[...].

Related terms

• HAL — other JSON format.