# json-api/json-api

A specification for building JSON APIs

Repository: https://github.com/json-api/json-api
Canonical: https://ross.abutalabs.com/products/json-api
Homepage: https://jsonapi.org
Language: CSS
License: CC0-1.0
License Family: permissive
Last push: 2025-03-13T15:09:19+00:00

## Health v2 (maintenance only)
Score: 37/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 11, release rhythm 35, longevity 100
- inputs: {"age_days": 4869, "days_push": 538, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 7719, forks 945 (observed 2026-08-28T04:10:02.575025+00:00)

## What it is
JSON:API is a specification (media type application/vnd.api+json) defining conventions for building JSON APIs, covering resource fetching, updates, relationships, and caching. This repository hosts the source for the jsonapi.org documentation site.

## Use cases
- standardize JSON API response format across a team
- design a REST API with consistent conventions
- reduce bikeshedding about JSON payload structure
- build a smart client that caches compound documents
- implement the application/vnd.api+json media type on a server

## When to choose
- you want a mature, stable v1.1 spec for JSON API conventions
- your team argues about response formatting and needs shared conventions
- you need efficient caching and compound document support in API clients

## When to avoid
- you need a library or framework, not a specification
- you prefer GraphQL or gRPC-style APIs
- you need full control over ad-hoc payload formats

## Facets
- artifact type: learning-resource
- maturity: stable
- function: serialization, api-framework, documentation, json
- domain: apis, web-development, backend, documentation
- platform: cross-platform
- tags: json-api, specification, media-type, rest, api-design, standards, web-server

## Member repositories
- json-api/json-api (main) score 37

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:02.575025+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T17:35:18.786250+00:00, confidence not recorded.
  - readme: https://github.com/json-api/json-api (fetched 2026-08-28T04:10:02.575025+00:00, sha 6c909cb0e6a8)
  - homepage: https://jsonapi.org (fetched 2026-08-29T08:31:27.218440+00:00, sha bc387f044006)
  - site_page: https://jsonapi.org/about (fetched 2026-08-29T08:31:27.229696+00:00, sha 0a05b7748cd1)
  - site_page: https://jsonapi.org/faq (fetched 2026-08-29T08:31:27.227385+00:00, sha 63c1bc915862)
  - site_page: https://jsonapi.org/format (fetched 2026-08-29T08:31:27.231372+00:00, sha b66f34f3dcc3)
- Data as of 2026-08-30T08:39:29.467469+00:00.