Skip to content

Commit

Permalink
Merge pull request #3994 from shaedrich/json-api
Browse files Browse the repository at this point in the history
Add topic "JSON:API"
  • Loading branch information
ahpook authored Oct 19, 2023
2 parents e0f74ef + a6d0626 commit 5c605eb
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions topics/json-api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
display_name: "JSON:API"
created_by: Yehuda Katz, Dan Gebhardt, Gabe Sullice, Jeldrik Hanschke, Tyler Kellen, Steve Klabnik,Ethan Resnick
logo: json-api.png
released: May 3, 2013
short_description: "JSON:API is a specification for building APIs in JSON."
topic: json-api
url: https://jsonapi.org
related: json, emberjs, rest-api, json-ld, hal, hateoas, siren, hydra, collection-json
---
**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:

* A generic media type that can work across a broad set of use cases, including the generally used relationship types
* Similarity to existing server-side framework practices (and human readability for debugging)
* Ease of implementation on the server side
* Ease of implementation on the client side

This specification reached a stable version 1.0 on May 29, 2015.
Binary file added topics/json-api/json-api.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5c605eb

Please sign in to comment.