URL, method, risror conventions ('GET',' POST', 'PUT' PUT',' DELETE ')
هذا يخفض عتبة الدخول، ويبسط عمليات التكامل، ويسمح للنظام بالتوسع دون فوضى.
اتفاقيات طرق URL و HTTP
| طريقة | الغرض | عينة الاستعلام | |
|---|---|---|---|
| 'GEt' | Get resource | ' GET/users/42 ' | |
| 'POST' | إنشاء | موارد جديدة' POST/USERS ' | |
| 'PUT' | تحديث كامل للموارد | 'PUT/USERS/42' | |
| 'PATCH' | Partial Resource Update (Opt.) | 'PATCH/USERS/42' | |
| 'حذف' | تحذف عبارة ' | الموارد' |
استخدم الجمع («/المستخدمون »، «/الأجهزة»، «/الألعاب »)
توصف الكيانات المتداخلة بأنها تسلسل هرمي ('/users/42/sessions')
جميع الطلبات تذهب عبر HTTPS
معايير التعامل مع الأخطاء
| رمز | قيمة | عينة رسالة |
|---|---|---|
| '400' | طلب غير صالح | 'المجال المفقود المطلوب: البريد الإلكتروني' |
| '401' | غير المصرح به ' | |
| '403' | رفض | 'منع الوصول إلى الموارد' |
| '404' | لم يتم العثور على | 'مستخدم يحمل بطاقة هوية 42 غير موجود' |
| '409' الصراع | (على سبيل المثال التكرار) | «البريد الإلكتروني المستخدم بالفعل» |
| '422' | يجب أن يكون خطأ التحقق | 'Field' age 'رقما' |
| '500' | خطأ الخادم الداخلي | 'استثناء غير متوقع، دعم الاتصال' |
هيكل الاستجابة للخطأ:
- "
- {
- «خطأ «: {
- «رمز «: 400،
- «رسالة «:» المجال المطلوب المفقود: البريد الإلكتروني «،
- تفاصيل
- }
- }
- ```
فوائد المطور
فهم سريع لمنطق واجهة برمجة التطبيقات بدون وثائق غير ضرورية
نهج موحد لجميع الوحدات والكيانات
سهولة التصحيح والتسجيل بفضل الرموز والتنسيقات القياسية
التوافق مع OpenAPI/Swagger و Postman و SDK autogeneration
يبسط الدعم والاختبار و CI/CD
حيثما كانت ذات أهمية خاصة
منصات واجهة برمجة التطبيقات المفتوحة أو الشريكة
مشاريع مع أفرقة تطوير متعددة
بنية الخدمات الدقيقة أو نهج واجهة برمجة التطبيقات أولاً
النظم مع العديد من الكيانات والتفاعلات
تجعل الاتفاقيات الموحدة واجهة برمجة التطبيقات موثوقة ومفهومة ومريحة. نحن نلتزم بأفضل ممارسات REST بحيث يتم كل تكامل بسرعة، دون سوء فهم وبأقصى قدر من القدرة على التنبؤ.
تواصل معنا
يرجى ملء النموذج أدناه وسنرد عليك في أقرب وقت ممكن.