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

هذه المهمة مخصصة لـ«كتابة توثيق API» داخل البرمجة / واجهات API. جوهرها: وثق كل endpoint بما يحتاجه المستهلك لتجربته.

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

• العقد
• المسارات
• المصادقة
• parameters
• نماذج الاستجابة
• الأخطاء

الطلب التقني

نفّذ مهمة «كتابة توثيق API» تقنيا ضمن البرمجة / واجهات API اعتمادا على السياق الفعلي الذي سأقدمه. السياق التقني: - [العقد] - [المسارات] - [المصادقة] - [parameters] - [نماذج الاستجابة] - [الأخطاء] طريقة التنفيذ والفحص: 1. وثق كل endpoint بما يحتاجه المستهلك لتجربته. 2. اعرض request وresponse حقيقيين وحالات الخطأ. 3. وضح auth وpagination وrate limits إن وجدت. المخرجات المقبولة: - توثيق API قابل للاستخدام. - أمثلة requests/responses. حافظ على حدود «كتابة توثيق API»: لا تحوّل الناتج إلى «تحديد أخطاء API»؛ استخدم عناصر المهمة المجاورة فقط عندما تكون مدخلا ضروريا لهذه المهمة. شرط القبول: هل يستطيع مطور التكامل دون قراءة الكود المصدر؟

ما يجب تسليمه

• توثيق API قابل للاستخدام
• أمثلة requests/responses

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

• هل يستطيع مطور التكامل دون قراءة الكود المصدر؟