JSON:API
jsonapi.org
JSON:API — A specification for building APIs in JSON
JSON:API covers creating and updating resources as well, not just responses.
Specification
This page presents the latest published version of JSON:API, which is currently version 1.1. New versions of JSON:API will always be backwards compatible using a never remove, only add strategy. Additions can be proposed in our discussion forum. If you catch an error in the specification’s text, ...
Examples
In practice, these characters should ... the base specification. See “Square Brackets in Parameter Names”. Here we want articles objects to have fields title, body and author only and people objects to have name field only. HTTP/1.1 200 OK Content-Type: application/vnd.api+json { "data": ...
Implementations
The following are projects implementing JSON:API. If you’d like your project listed, send a pull request. Note: This specification marked 1.0 on May 29th, 2015.
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 of the base JSON:API specification.
Medium
medium.com › @niranjan.cs › what-is-json-api-3b824fba2788
What is JSON API?. A brief post about what JSON API… | by Niranjan Sathindran | Medium
November 8, 2019 - JSON API targets cases where typical standard MIME type (think application/json) data exchange becomes too chatty. Lets talk about about that “chattiness” using an example here, and for simplicity I’ll use the same example used by jsonapi.org. Consider the example of a blog post site that displays a single article at a time, with links to next and previous articles of say the same author or a specific series.
JSON API - A specification for building APIs in JSON
Seems a bit unnecessary. Does anyone use this? Maybe someone could talk about some pros and cons? I think people would argue just as much about this as they would otherwise. More on reddit.com
34
92
June 22, 2015Is there any standard for JSON API response format? - Stack Overflow
For error responses specifically I also like the Problem Details for HTTP APIs RFC draft. 2014-02-13T12:36:19.207Z+00:00 ... Maybe you want to add code.google.com/p/json-service to the description format list? More on stackoverflow.com
A simple JSON API spec
While some good API specifications do exist, this project attempts to provide a common middle-ground being not too complex, while broad enough to not be too specific and too complex · While, for instance, JSON:API is a thorough specification, Simple JSON API aims to provide a much simplified ... More on news.ycombinator.com
1
2
May 27, 2024Should I adhere to the JSON::API specification when developing APIs? Jbuilder or jsonapi-serializer?
JSON:API provides standard ways of handling filters, relationships/includes, sparse fieldsets, meta and more. If you're going to use those things then it can be quite helpful. I wouldn't say it's essential though, especially for simpler APIs. More on reddit.com
8
5
September 22, 2023Videos
Columbia University
columbia.edu › ~alan › django-jsonapi-training › jsonapi.html
The {json:api} specification
The main {json:api} concept is that it manipulates a collection of objects. Each resource item always has a type and id along with attributes. Optional relationships show how this object relates to others, which themselves are identified by their type and unique id.
JSON:API
jsonapi.org › format
JSON:API — Latest Specification (v1.1)
JSON:API requires use of the JSON:API media type (application/vnd.api+json) for exchanging data. All document members, query parameters, and processing rules defined by this specification are collectively called “specification semantics”.
Unit
unit.co › about json:api
About JSON:API | Unit
JSON:API specifies how a client should request resources to be fetched or modified, and how a server should respond to those requests.
GitHub
github.com › json-api › json-api
GitHub - json-api/json-api: A specification for building JSON APIs · GitHub
Documentation for the application/vnd.api+json media type, a specification for APIs that use JSON.
Starred by 7.7K users
Forked by 920 users
Languages CSS 43.6% | JavaScript 37.8% | HTML 7.7% | Sass 3.4% | Python 2.9% | Makefile 2.0%
Devchecklists
devchecklists.com › en › checklist › json-api-specification
DevChecklists | JSON: API Specification
Servers MUST send all JSON:API data in response documents with the header Content-Type: application/vnd.api+json without any media type parameters · Servers MUST respond with a 415 Unsupported Media Type status code if a request specifies the header Content-Type: application/vnd.api+json with ...
Swagger
swagger.io › specification
OpenAPI Specification - Version 3.1.0 | Swagger
The OpenAPI Specification defines a standard interface to RESTful APIs which allows both humans and computers to understand service capabilities without access to source code, documentation, or network traffic inspection.
Apidog
apidog.com › blog › json-api-specification
A Complete Introduction to the JSON:API Specification
May 19, 2025 - Client libraries can be developed to handle much of the boilerplate for interacting with any JSON:API compliant service. Enhanced Discoverability and Usability: Consistent link structures and clear delineation of resources and relationships make APIs easier to understand and navigate. Optimized Data Transfer: Features like sparse fieldsets and compound documents allow clients to request only the data they need, minimizing payload sizes and reducing the number of HTTP requests. Easier Caching: The specification promotes the use of standard HTTP caching mechanisms.
Reddit
reddit.com › r/javascript › json api - a specification for building apis in json
r/javascript on Reddit: JSON API - A specification for building APIs in JSON
June 22, 2015 - Example: one cannot traverse JSON API given a single entry point and its media type, an "index" payload is not defined in the spec. Just because we don't tell you what goes on the index doesn't mean you can't put something as your index. In any case, if you prefer one of those other types, they're great too. Each media type has a problem it's trying ot solve, and we have a specific one.
Top answer 1 of 16
894
Yes there are a couple of standards (albeit some liberties on the definition of standard) that have emerged:
- JSON API - JSON API covers creating and updating resources as well, not just responses.
- JSend - Simple and probably what you are already doing.
- OData JSON Protocol - Very complicated.
- HAL - Like OData but aiming to be HATEOAS like.
There are also JSON API description formats:
- Swagger
- JSON Schema (used by swagger but you could use it stand alone)
- WADL in JSON
- RAML
- HAL because HATEOAS in theory is self describing.
2 of 16
327
Google JSON guide
Success response return data
{
"data": {
"id": 1001,
"name": "Wing"
}
}
Error response return error
{
"error": {
"code": 404,
"message": "ID not found"
}
}
and if your client is JS, you can use if ("error" in response) {} to check if there is an error.
ApisYouWontHate
apisyouwonthate.com › newsletter › api-specs-schemas-and-standards
API Specs, Schemas and Standards
October 16, 2023 - JSON API standardizes API design specifics, while OpenAPI and JSON Schema describe the service model and data instances.
JSON:API
jsonapi.org › format › 1.0
JSON:API — Specification v1.0 (Archived Copy)
JSON:API documents are defined in JavaScript Object Notation (JSON) [RFC7159]. Although the same media type is used for both request and response documents, certain aspects are only applicable to one or the other. These differences are called out below. Unless otherwise noted, objects defined ...
JSON
json.org
JSON
JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. It is based on a subset of the JavaScript Programming Language Standard ECMA-262 3rd Edition - December 1999.
CloudBees
cloudbees.com › blog › the-json-api-spec
How to Build Rails APIs Following the json:api Spec
The json:api spec isn't just limited to how the server should format JSON responses. It also speaks to how the client should format requests, how to handle sorting, pagination, errors, and how new resources should be created.
Hacker News
news.ycombinator.com › item
A simple JSON API spec | Hacker News
May 27, 2024 - While some good API specifications do exist, this project attempts to provide a common middle-ground being not too complex, while broad enough to not be too specific and too complex · While, for instance, JSON:API is a thorough specification, Simple JSON API aims to provide a much simplified ...
Google
developers.google.com › custom-search › v1 › overview
Custom Search JSON API | Google for Developers
January 20, 2026 - The Custom Search JSON API uses the OpenSearch 1.1 Specification.
API Conference
apiconference.net › api-design › getting-productive-with-jsonapi-specification
Getting productive with JSON:API specification - API Conference
October 1, 2021 - Luckily, you do not have to solve all problems on your own. Instead, you could build on top of well-established tools and standards like GraphQL or the JSON:API specification. JSON:API is a standard for building REST APIs.
Medium
medium.com › apis-you-wont-hate › json-api-openapi-and-json-schema-working-in-harmony-ad4175f4ff84
JSON API, OpenAPI and JSON Schema Working in Harmony | by Phil Sturgeon | APIs You Won't Hate | Medium
September 24, 2018 - Firstly, JSON API explains what shape the body of the HTTP request and response should take. Specifically, where primary data goes, where meta data goes, where should links to other resources be placed, and how exactly should related data be ...
Reddit
reddit.com › r/rails › should i adhere to the json::api specification when developing apis? jbuilder or jsonapi-serializer?
r/rails on Reddit: Should I adhere to the JSON::API specification when developing APIs? Jbuilder or jsonapi-serializer?
September 22, 2023 -
Hello everyone!
I'm currently working on a Rails project and am considering using either Jbuilder or jsonapi-serializer for handling JSON responses. I'm aware that the JSONAPI specification provides a standardized approach for APIs, but I'm undecided on whether to adhere to it.
For my project, I'm not heavily focused on documentation but rather on a code-first approach. I'd love to hear your thoughts:
Would you still recommend following the JSONAPI specification even if documentation isn't a priority?
For a Rails project, do you prefer Jbuilder or JSONAPI-Serializer? Why?
Looking forward to your insights and experiences.
Top answer 1 of 3
6
JSON:API provides standard ways of handling filters, relationships/includes, sparse fieldsets, meta and more. If you're going to use those things then it can be quite helpful. I wouldn't say it's essential though, especially for simpler APIs.
2 of 3
2
If documentation is not priority, use a standard specification is way more important. So yes, go with JSONAPI spec. Side note: I don't like that much graphql (I think they're a pain to write), but its auto-documentation features are a bless for frontend developers.