JSON:API
JSON:API ist eine REST-API-Antwortformatspezifikation, die Ressourcenobjekte, Beziehungen, Pagination und Fehler standardisiert und API-Design-Divergenz verringert.
Zweck
REST-APIs eine einheitliche Antwortstruktur geben, damit Clients Ressourcen, Beziehungen und Fehler generisch behandeln können.
Mechanismus
Antworten enthalten data (Ressourcenobjekt-Array/-Objekt), included (vorab geladene verwandte Ressourcen), meta und errors. Ressourcenobjekte enthalten id, type, attributes und relationships; Beziehungen referenzieren links oder data.
Anwendungsfälle
- Standardisierung von REST-API-Antworten
- Frontend-Backend-Datenverträge
- Pagination und Compound-Loading