RESTful API JSON Response Design: So sieht eine gute Struktur aus
2024-06-28
Wenn jedes Endpoint ein anderes Antwortschema nutzt, wachsen Adapter und Sonderfaelle. Einheitliche JSON-Konventionen sparen Monate Integrationsaufwand.
Envelope
Ob direktes Objekt oder { data, meta, errors }: wichtiger als Minimalismus ist Konsistenz.
{ "data": { "id": 1 }, "meta": { "requestId": "abc" } }Fehlerobjekte
HTTP-Status plus maschinenlesbarer Code, Nachricht und Feld-Details schaffen klare Client-Logik.
Pagination
Systemweit entweder Cursor oder Offset standardisieren und Array-Feldnamen konsistent halten.
Naming und Zeitformat
Entscheidung fuer camelCase oder snake_case; Datumswerte als ISO-8601-Strings.
Weiterentwicklung
In v1 additive Aenderungen bevorzugen; Breaking Changes in neue Version auslagern.