كيفية استخدام عارض OpenAPI
- الصق المواصفة أو انقر «تحميل مثال».
- انقر «عرض» (أو اضغط Ctrl/Cmd+Enter).
- استخدم المرشّح للعثور على نقطة نهاية ووسّعها لقراءة معاملاتها واستجاباتها.
مزايا عارض OpenAPI
- OpenAPI 3.0/3.1 وSwagger 2.0 بصيغة JSON أو YAML، مع تحليل يجري بالكامل في المتصفح
- العمليات مجمّعة حسب الوسم (tag) مع شارات الطريقة والمسار والملخص وعلامات الإهمال (deprecation) والمصادقة
- تفاصيل قابلة للتوسيع: المعاملات ومتن الطلب والاستجابات لكل رمز حالة والأمان وأزرار النسخ
- المخططات مع جداول الخصائص وJSON الخام، ومخططات الأمان، والخوادم
- مرشّح فوري عبر الطرق والمسارات ومعرّفات العمليات (operationId) والوسوم وأسماء المخططات؛ مع توسيع/طي الكل
- تُعرض المشكلات البنيوية في شريط تحذير دون حجب العرض
مثال على عارض OpenAPI
استكشاف واجهة API صغيرة
الإدخال:
openapi: 3.0.3
paths:
/books:
get:
summary: List books
responses:
"200": { description: OK }النتيجة:
default (1)
GET /books — List books
Responses: 200 OKالأسئلة الشائعة حول عارض OpenAPI
ما الصيغ التي يمكنني لصقها؟
OpenAPI 3.0 و3.1 إضافة إلى Swagger 2.0، بصيغة JSON أو YAML. يُكتشف الإصدار من الحقل openapi / swagger.
كيف تُنظَّم العمليات؟
حسب الوسم، بترتيب إعلان الوسوم، مع وضع العمليات غير الموسومة تحت «default». وتتوسّع كل عملية لعرض المعاملات (الاسم والموقع والنوع وهل هي مطلوبة)، ومتن الطلب مع أنواع المحتوى والمخطط، والاستجابات لكل رمز حالة، ومتطلبات الأمان.
هل تُحلّ مراجع $ref؟
تُعرض المراجع المحلية (#/components/schemas/Name و#/definitions/Name) بالاسم، ويسرد قسم المخططات كل مكوّن مع خصائصه وJSON الخام. أما مراجع الملفات الخارجية فتُعرض كما هي.
هل يمكنني البحث داخل مواصفة كبيرة؟
نعم. يطابق مربع المرشّح الطريقة والمسار والملخص وoperationId والوسوم وأسماء المخططات. استخدم «توسيع الكل» / «طي الكل» لفتح جميع الأقسام أو إغلاقها.
ملاحظات تقنية
يبني العارض نموذجاً مطبَّعاً مشتركاً مع المدقّق: الوسوم ← العمليات ← المعاملات/requestBody/الاستجابات، والمكوّنات ← المخططات. وتُحلّ مؤشرات $ref المحلية عبر JSON Pointer؛ وتُلخَّص تسميات المخططات (array<Book> وstring(uuid) وenum(a, b)) حتى تبقى الجداول مقروءة.