Conception de reponse JSON RESTful : a quoi ressemble une bonne API
2024-06-28
Quand chaque endpoint invente son format, le client accumule des adaptateurs. Une convention simple et stable economise beaucoup de dette.
Envelope
Vous pouvez utiliser { data, meta, errors } ; l'essentiel est la coherence entre endpoints.
{ "data": { "id": 1 }, "meta": { "requestId": "abc" } }Erreurs
Associez statut HTTP, code machine, message humain et details par champ.
Pagination
Choisissez cursor ou offset a l'echelle produit et gardez des noms de listes coherents.
Nommage et temps
Ne melangez pas camelCase et snake_case ; utilisez ISO 8601 de maniere uniforme.
Evolution
Favorisez des ajouts non cassants en v1 ; pour les ruptures, versionnez et mettez a jour OpenAPI et fixtures.