RESTful API JSON Response Design: अच्छे ढांचे की पहचान
2024-06-28
अगर हर endpoint अलग response shape लौटाए, तो client adapters बढ़ते जाते हैं। एक छोटा साझा convention बड़े maintenance लाभ देता है।
Envelope
{ data, meta, errors } अपनाएं या न अपनाएं, पर एक जैसी संरचना रखना प्राथमिकता होनी चाहिए।
{ "data": { "id": 1 }, "meta": { "requestId": "abc" } }Errors
HTTP status के साथ machine-readable code, human message और field details लौटाएं।
Pagination
Cursor या offset में एक तरीका चुनें और array field naming consistent रखें।
Naming और time
camelCase या snake_case में एकरूपता रखें; timestamps ISO 8601 में दें।
Evolution strategy
v1 में additive changes रखें; breaking changes को v2 में स्पष्ट रूप से अलग करें।