كيف تعمل الأداة؟
افتح تعريف OpenAPI بصيغة JSON وراجع معلومات الواجهة والمسارات والطرق. افحص الأخطاء والقيم الأساسية قبل مشاركة التوثيق أو استعماله في التطوير. تقرأ الأداة مستند OpenAPI بصيغة JSON، وتراجع حقولًا من البنية ثم تعرض العمليات التابعة لكل مسار وطريقة HTTP. ألصق تعريف OpenAPI بصيغة JSON، ثم شغّل فحص البنية. راجع قائمة المسارات وطرق HTTP والمتطلبات، وافتح ملاحظات التحقق حول الحقول التي تحتاج إلى تعديل.
طريقة الاستخدام
ألصق تعريف OpenAPI بصيغة JSON، ثم شغّل فحص البنية.
راجع قائمة المسارات وطرق HTTP والمتطلبات، وافتح ملاحظات التحقق حول الحقول التي تحتاج إلى تعديل.
قارن النتيجة بالسلوك الفعلي للواجهة، خصوصًا قيم الاستجابات والرموز التي تعتمد على بيئة التشغيل.
أهم الميزات
- فحص بنية JSON الخاصة بـOpenAPI
- قائمة المسارات والعمليات
- معاينة المعاملات والاستجابات
- تنبيهات للحقول التي تحتاج إلى مراجعة
الطريقة والمعادلات
تقرأ الأداة مستند OpenAPI بصيغة JSON، وتراجع حقولًا من البنية ثم تعرض العمليات التابعة لكل مسار وطريقة HTTP.
حالات الاستخدام
- ابحث عن عمليات API مفقود عملية الهوية
- تحقق من المراجع الداخلية بعد تحرير المواصفات
- استعراض مسارات وطرق HTTP قبل توليد العميل
أمثلة تطبيقية
استعراض مثال متجر الحيوانات
حمّل مثال OpenAPI 3.0.3 المدمج وفيه المساران /pets و/pets/{petId}. يعرض التقرير مسارين و3 عمليات ومخططًا واحدًا. يشير التنبيه إلى غياب operationId ووسم admin غير المعرّف.
تعتمد هذه التنبيهات على الفحوص التي يدعمها المستعرض.
حدود الأداة
- • يركز الفاحص على فحوص البنية المدعومة، وقد تحتاج قواعد OpenAPI الأخرى إلى أداة تحقق إضافية.
- • لا يتأكد الفحص البنيوي من تطابق الاستجابات الفعلية مع الوصف.
ملفاتك وخصوصيتك
تعالج أداة مدقق OpenAPI ومستعرض العمليات ملفاتك ومدخلاتك على جهازك.
يتولى متصفحك المعالجة من دون إرسال الملفات إلى خادم.
لا يسجل Microdeck النصوص أو الملفات التي تستخدمها في الأدوات. تحتاج الصفحة إلى اتصال بالإنترنت كي تُحمّل.
نزّل النتائج التي تريد الاحتفاظ بها أو انسخها قبل إغلاق علامة التبويب. تحفظ بعض الأدوات المسودات في متصفحك.
الأسئلة الشائعة
هل هذا يسمى أي نقاط نهاية API؟
إنها تقرأ المواصفات الملصقة استخدم بيئة اختبار للطلبات
لماذا يحذر من عملية تحديد الهوية؟
الهوية غير موجودة في عملية بعض مولدات العملاء تعتمد عليها في التسمية
ماذا يحدث للمراجع الخارجية؟
ويقتصر التحقق المرجعي على الأهداف الواردة في الوثيقة الملصقة.