تصميم استجابات JSON في RESTful API

Envelope

سواء استخدمت { data, meta, errors } أو لا، الاتساق بين جميع endpoints هو الأهم.

{ "data": { "id": 1 }, "meta": { "requestId": "abc" } }

اجمع بين حالة HTTP وكود آلي ورسالة بشرية وتفاصيل حقول لتسهيل المعالجة في العميل.

وحّد نهج cursor أو offset على مستوى المنتج، وثبّت اسم مصفوفة البيانات.

لا تخلط camelCase وsnake_case، واستخدم تواريخ ISO 8601 دائمًا.

في v1 اعتمد تغييرات إضافية فقط، وانقل التغييرات الكاسرة إلى v2 بوضوح.