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