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