في هذه الصفحة
باختصار#
مجموعة واحدة من القواعد للواجهات التي ينشرها المزوّدون على API360 ولواجهات النطاقات الخاصة بالمنصة. تعرض كل صفحة عائلة قواعد واحدة، وتبيّن الشكل على الشبكة، وتسمّي قواعد الفحص التي تتحقق منه. تعمل القواعد كمجموعة قواعد Spectral، فيُفحص التعريف بالطريقة نفسها على جهازك وفي خط البناء وفي Studio.
| الصفحة | عائلة القواعد | ما تضبطه |
|---|---|---|
| التسمية | أسماء snake_case | أسماء الخصائص ومعاملات الاستعلام وقيم التعداد، وأجزاء المسار |
| الأخطاء | غلاف خطأ واحد | جسم الخطأ ورموز الحالة وترويسات إعادة المحاولة |
| الترقيم | page وper_page | المعاملات والحد الأقصى 100 والإجمالي في الجسم |
| التكرار الآمن | Idempotency-Key | إعادة محاولة آمنة لطلب POST ينشئ عنصراً |
| الإصدارات | الإصدار الرئيسي في المسار | موضع الإصدار وما يستلزم تغييره |
| الإيقاف | Deprecation وSunset | كيف تعلن العملية التي سيُوقف العمل بها عن نفسها |
| الأمان | متطلب على كل عملية | بيانات الاعتماد في الترويسات لا في العنوان |
| فحص تعريف الواجهة | مجموعة القواعد | كيف تشغّلها، وملفاها الشخصيان، وقائمة الاستثناءات المؤرَّخة |
لمن هذه القواعد#
- يصمّم المزوّد واجهته وفق هذه القواعد، ويفحص ملف OpenAPI قبل النشر.
- تفحص المنصة تعريفات نطاقاتها الثلاثة عشر وفق القواعد نفسها، مع قائمة مؤرَّخة بالملاحظات التي ما زالت تحملها.
- يقرأ المستهلك الصفحات نفسها ليعرف ما يتوقعه من أي منتج: جسم الخطأ نفسه، والترقيم نفسه، وقواعد إعادة المحاولة نفسها.
مخطّط له
يشغّل Studio الملف الشخصي الخاص بالمزوّد من مجموعة القواعد على كل تعريف يرفعه المزوّد، ويعرض الملاحظات بجانب الملف.
ذات صلة#
- الأخطاء ورموز الحالة وإعادة المحاولة: ما يراه المستهلك اليوم.
- الإصدارات والتغييرات الكاسرة: التعريف المكتوب للتغيير الكاسر.
- للمزوّدين: نشر المنتج وإصداره.
آخر تحديث 2026-10-17