المشكلة التقنية أو المخرج

هذه المهمة مخصصة لـ«تصميم REST API» داخل البرمجة / واجهات API. جوهرها: حدد مكونات REST API وعلاقة كل مكون بالهدف.

بيئة التنفيذ والسياق

• الهدف الذي يجب أن يحققه REST API
• المستخدم أو الجمهور المستفيد من REST API
• المكونات الضرورية لـREST API
• القيود التي تحكم REST API
• مرجع أو مثال عند توفره
• العقد
• المسارات

الطلب التقني

نفّذ مهمة «تصميم REST API» تقنيا ضمن البرمجة / واجهات API اعتمادا على السياق الفعلي الذي سأقدمه. السياق التقني: - [الهدف الذي يجب أن يحققه REST API] - [المستخدم أو الجمهور المستفيد من REST API] - [المكونات الضرورية لـREST API] - [القيود التي تحكم REST API] - [مرجع أو مثال عند توفره] - [العقد] - [المسارات] طريقة التنفيذ والفحص: 1. حدد مكونات REST API وعلاقة كل مكون بالهدف. 2. ابن نسخة أولية من REST API تحقق وظيفتها الأساسية قبل إضافة التفاصيل الثانوية. 3. اختبر REST API على حالة استخدام واقعية مرتبطة بـواجهات API. 4. راجع اتساق REST API واكتماله ثم حسّن الجزء الذي يحد جودة هذه المهمة. 5. ثبت contract قبل تفاصيل التنفيذ. 6. استخدم status codes وهيكل أخطاء متسق. المخرجات المقبولة: - REST API مكتمل وقابل للاستخدام. - تفاصيل المكونات أو القرارات التي بُني عليها REST API. - عقد API أو تنفيذ متوافق. حافظ على حدود «تصميم REST API»: لا تحوّل الناتج إلى «تحديد نقاط النهاية»؛ استخدم عناصر المهمة المجاورة فقط عندما تكون مدخلا ضروريا لهذه المهمة. شرط القبول: هل يعمل REST API كوحدة مستقلة ويحقق الهدف الذي أُنشئ من أجله؟

ما يجب تسليمه

• REST API مكتمل وقابل للاستخدام
• تفاصيل المكونات أو القرارات التي بُني عليها REST API
• عقد API أو تنفيذ متوافق

معيار قبول الحل

• هل يعمل REST API كوحدة مستقلة ويحقق الهدف الذي أُنشئ من أجله؟
• هل يستطيع عميل آخر التكامل من التوثيق وحده؟