Sep 30, 2022 · Format documentation To get started with JSON:API, check out documentation for the base specification. Extensions The JSON:API community has created a collection of extensions that …

Examples This page contains additional examples of how to apply various parts of the specification. Sparse Fieldsets Examples of how sparse fieldsets work. Basic request:

Introduction JSON:API is a specification for how a client should request that resources be fetched or modified, and how a server should respond to those requests. JSON:API can be easily extended …

About Channels JSON:API is: @jsonapi on Twitter #jsonapi channel on Freenode IRC jsonapi discussion forum Editors There are four active editors of this specification: Yehuda Katz Dan …

Recommendations This section contains recommendations for JSON:API implementations. These recommendations are intended to establish a level of consistency in areas that are beyond the scope …

Playground json-api-document-viewer the flat json:api structure is a good way to express complex relationships between objects. However the same flatness makes it difficult for humans to “parse” …

A logical collection of resources MUST be represented as an array, even if it only contains one item or is empty. Resource Objects “Resource objects” appear in a JSON:API document to represent …

JSON:API thinks through how to update existing records (leaning on PATCH and JSON Patch), and how those updates interact with compound documents returned from GET requests. It also describes how …

Atomic Operations This extension provides a means to perform multiple “operations” in a linear and atomic manner. Operations are a serialized form of the mutations allowed in the base JSON:API …

Extensions and Profiles The JSON:API specification provides a way to define new functionality not provided by the base specification using extensions. Additionally, it provides a means to share a …