JSON:API Beispiele: Ressource, Liste, Fehler
JSON:API ist eine Spezifikation für JSON-Schnittstellen mit festem Aufbau aus type, id, attributes, relationships und links; der Content-Type lautet application/vnd.api+json. Die Seite zeigt eine einzelne Ressource, eine Liste mit Paginierung, ein Fehlerobjekt und verknüpfte Ressourcen über included. Damit lassen sich Clients und Serialisierer gegen das Format prüfen.
4 Varianten auf einer Seite, jede mit eigenem Kopier- oder Download-Knopf.
JSON:API: einzelne Ressource
{ "data": { "type": "kunden", …Struktur nach jsonapi.org: type, id, attributes, relationships, links. Content-Type application/vnd.api+json.
JSON:API: Liste mit Paginierung und meta
{ "data": [ { …Paginierung über page[...]-Parameter und links.
JSON:API: Fehlerobjekt
{ "errors": [ { …errors als Liste; source.pointer verweist per JSON Pointer.
JSON:API: included (verknüpfte Ressourcen)
{ "data": { "type": "rechnungen", …Abfrage mit ?include=kunde.