Skip to content

Commit 5c605eb

Browse files
authored
Merge pull request #3994 from shaedrich/json-api
Add topic "JSON:API"
2 parents e0f74ef + a6d0626 commit 5c605eb

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

topics/json-api/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
display_name: "JSON:API"
3+
created_by: Yehuda Katz, Dan Gebhardt, Gabe Sullice, Jeldrik Hanschke, Tyler Kellen, Steve Klabnik,Ethan Resnick
4+
logo: json-api.png
5+
released: May 3, 2013
6+
short_description: "JSON:API is a specification for building APIs in JSON."
7+
topic: json-api
8+
url: https://jsonapi.org
9+
related: json, emberjs, rest-api, json-ld, hal, hateoas, siren, hydra, collection-json
10+
---
11+
**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 is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This first draft was extracted from the JSON transport implicitly defined by Ember Data’s REST adapter. In general, Ember Data’s goal is to eliminate the need for ad-hoc code per application to communicate with servers that communicate in a well-defined way. The REST Adapter in Ember Data implicitly defined a protocol that custom servers could implement to get a drop-in client for all of their resources. The goals of the media type are to balance:
12+
13+
* A generic media type that can work across a broad set of use cases, including the generally used relationship types
14+
* Similarity to existing server-side framework practices (and human readability for debugging)
15+
* Ease of implementation on the server side
16+
* Ease of implementation on the client side
17+
18+
This specification reached a stable version 1.0 on May 29, 2015.

topics/json-api/json-api.png

9.99 KB
Loading

0 commit comments

Comments
 (0)