توثيق API آلي من الكود المصدري

تخلّص من التحديثات اليدوية لـ Swagger. تُجري هذه المهارة تحليلاً ساكناً عميقاً على كود الواجهة الخلفية لديك لتوليد توثيق API احترافي فوري. تقوم بتعيين المسارات والأساليب والمخططات ومتطلبات المصادقة دون الحاجة إلى أي إدخال يدوي أو مفاتيح API.

ما الذي تفعله

• اكتشاف متعدد الأطر: تدعم Node.js (Express, Next.js, Hono, Koa) وPython (FastAPI, Flask, Django REST) وغيرها.
• استخراج عميق للمخططات: تستنتج أشكال الطلبات والاستجابات من واجهات TypeScript ومخططات Zod ونماذج Pydantic وتعليقات JSDoc.
• تعيين المصادقة: تحدد تلقائياً المسارات المحمية عبر الكشف عن الوسيط مثل JWT وPassport وتبعيات FastAPI.
• صيغتا إخراج مزدوجتان: تصدّر إلى YAML صالح لـ OpenAPI 3.0 للأدوات البرمجية، أو Markdown نظيف لملفات README والويكي الداخلية.

لماذا تستخدم هذه المهارة؟

كتابة التوثيق مهمة مرهقة وعرضة للانفصال عن الواقع. على خلاف الأوامر العامة، تستخدم هذه المهارة إرشادات محددة لفحص نظام الملفات لديك، وفهم أنماط التوجيه الخاصة بكل إطار، واستنتاج الأنواع من اصطلاحات تسمية المتغيرات عند غياب الأنواع الصريحة. تنتج توثيقاً منظماً وجاهزاً للنشر يتبع معايير الصناعة.

الأدوات الصناعية المدعومة

• المواصفات: OpenAPI 3.0.3 (Swagger)
• التوثيق: Markdown بنكهة GitHub
• التحقق: متوافق مع Swagger UI وRedoc وPostman