JSON API
E97089
JSON API is a standardized specification for building JSON-based RESTful APIs that defines how clients should request and modify resources in a consistent, structured format.
Aliases (1)
- JSON:API ×1
Statements (59)
| Predicate | Object |
|---|---|
| instanceOf |
JSON-based API specification
→
RESTful API specification → web API specification → |
| category |
API design
→
web development → |
| defines |
a specification for building JSON-based APIs
→
a standard format for error objects → a standard format for links objects → a standard format for meta objects → a standard format for primary data → a standard format for relationship objects → a standard format for resource objects → a top-level JSON document structure → conventions for filtering parameters → conventions for including related resources → conventions for pagination parameters → conventions for query parameters → conventions for sorting parameters → |
| focusesOn |
client-server interactions
→
consistent API structure → minimizing the amount of data transmitted → minimizing the number of HTTP requests → reducing boilerplate in API design → resource-based APIs → standardizing how clients request and modify resources → |
| fullName |
JSON:API
→
|
| goal |
to improve interoperability between clients and servers
→
to make APIs self-descriptive → to promote consistency across APIs → to reduce ad-hoc API designs → to reduce client-side code complexity → to reduce server-side code complexity → |
| primaryFormat |
JSON
→
|
| relatedTo |
GraphQL
→
HAL (Hypertext Application Language) → OpenAPI Specification → REST → |
| supports |
compound documents
→
error object standardization → filtering → inclusion of related resources via include parameter → links objects → meta information objects → pagination → relationships between resources → resource creation → resource deletion → resource fetching → resource updating → sideposting of related resources (in some implementations) → sorting → sparse fieldsets → |
| typicalUseCase |
internal service APIs
→
public web APIs → single-page application backends → |
| uses |
HTTP as transport protocol
→
media type application/vnd.api+json → standard HTTP methods → standard HTTP status codes → |
Referenced by (2)
| Subject (surface form when different) | Predicate |
|---|---|
|
JSON API
("JSON:API")
→
|
fullName |
|
Python Package Index
→
|
supportsFormat |