مواصفة OpenAPI
الهدف
الحصول على مستند OpenAPI 3 القابل للقراءة آلياً لواجهة البرمجة العامة v1.
لمن
المكاملون الذين يولّدون عملاء واختبارات العقد.
المتطلبات
- مركز المساعدة متاح (أو لديك YAML من المستودع).
الخطوات
- نزّل YAML: public-api-v1-openapi.yaml.
- استورده في Insomnia أو Postman أو openapi-generator.
- طابقه مع واجهة البرمجة العامة والمرجع السردي.
النتيجة
العملاء والاختبارات تطابق عقد القراءة فقط.
ملاحظة
يُحفظ YAML في docs/help/public/. عند تغيّر العقد حدّث نسخة المساعدة مع مسارات الخلفية.