واجهة API اتفاق بين أنظمة مستقلة. إذا تغيّر شكل البيانات أو معنى الحالة دون إعلان، فقد تتعطل تطبيقات تعمل بإصدارات أقدم رغم أن الخادم الجديد يبدو سليمًا.
الفكرة الأساسية
عرّف الموارد وأسماء الحقول والأنواع وحالات الخطأ قبل كتابة المسارات. افصل البيانات المستقرة عن التفاصيل الداخلية، ووضّح أي الحقول اختياري وكيف تُفسر القيم الفارغة.
خطوات عملية
- اكتب طلبًا واستجابة نموذجيين للعملية الرئيسية.
- وحّد شكل الأخطاء مع رمز يمكن للتطبيق التعامل معه.
- راجع التغييرات مع مستهلك للواجهة واختبر التوافق.
مثال تطبيقي
في خدمة حجوزات، أعد معرف الحجز وحالته بوضوح. لا تجعل التطبيق يستنتج النجاح من رسالة نصية قد تتغير عند الترجمة.
خطأ شائع ينبغي تجنبه
إضافة حقل غالبًا أسهل من تغيير نوع حقل قائم، لكنها قد تؤثر في عملاء صارمين. اختبر المستهلكين المهمين قبل النشر.
للتوسع في الموضوع
صور توضيحية: الغلاف من Unsplash، الصورة الداخلية من Unsplash. ترخيص الاستخدام.
