ما هو OpenAPI
مواصفات لوصف واجهات REST API
OpenAPI هي مواصفات قياسية لوصف واجهات REST API، تتيح التوثيق الآلي وتوليد الكود.
فوائد OpenAPI
- معيار موحد لوصف API
- توثيق مولد تلقائياً
- توليد كود العميل
- التحقق من الطلبات والاستجابات
المكونات الرئيسية
- Info — بيانات وصفية للـ API
- Paths — نقاط النهاية والعمليات
- Components — مخططات قابلة لإعادة الاستخدام
- Security — طرق المصادقة
- Servers — عناوين URL الأساسية
الأدوات
- Swagger UI — توثيق تفاعلي
- Swagger Editor — محرر المواصفات
- OpenAPI Generator — توليد الكود
- Redoc — توثيق بديل