ToolRobinمن دون تسجيل دخول، استخدمه مباشرة

مدقق توافق OpenAPI

قارن اثنين من مواصفات OpenAPI 3.x محليًا وراجع تغييرات عقد واجهة برمجة التطبيقات (API) المحتملة حسب العملية والمسار الميداني.

الصق أو اختر ملفات OpenAPI 3.0 أو 3.1 أو 3.2 الأصلية والمعدلة. تحقق من مدى الخطورة ومسار الحقل المتأثر، ثم قم بتنزيل تقرير Markdown أو JSON للمراجعة.

قارن بين ملفين من ملفات OpenAPI قبل الإصدار. تبقى المواصفات في هذا المتصفح.

الصق JSON أو YAML أدناه، أو اختر ملفًا.
الصق JSON أو YAML أدناه، أو اختر ملفًا.

كل ملف: يصل حجمه إلى 2 ميجابايت و1000 عملية. يدعم OpenAPI 3.0 و3.1 و3.2.

طريقة الاستخدام

قم بمراجعة تغييرات OpenAPI قبل إصدار API

قارن اثنين من مواصفات OpenAPI 3.x محليًا وراجع تغييرات عقد واجهة برمجة التطبيقات (API) المحتملة حسب العملية والمسار الميداني.

خطوات الاستخدام

  1. أدخل المصدر عبر: المواصفات الأصلية / المواصفات المنقحة.
  2. نفّذ: التحقق من التوافق. افحص النتيجة قبل النسخ أو التنزيل أو الاستخدام في مكان آخر.
  3. الصق أو اختر ملفات OpenAPI 3.0 أو 3.1 أو 3.2 الأصلية والمعدلة. تحقق من مدى الخطورة ومسار الحقل المتأثر، ثم قم بتنزيل تقرير Markdown أو JSON للمراجعة.

اختيار الإعدادات

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

مثال والنتيجة المتوقعة

إذا كانت استجابة GET /users/{id} المنقحة تجعل حقل "البريد الإلكتروني" اختياريًا مطلوبًا، يضع التقرير علامة على عقد الاستجابة الذي تم تغييره. يتم اتباع المراجع المحلية `$ref`؛ يتم استدعاء المراجع الخارجية وتكوين المخططات المعقدة للمراجعة اليدوية. هذا ليس مدققًا كاملاً للمواصفات أو اختبارًا لواجهة برمجة التطبيقات قيد التشغيل.

إذا لم يعمل

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

ما هي التغييرات التي تم فحصها؟

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

كيف يتم التعامل مع المراجع؟

يتم اتباع المراجع الموجودة في ملف المواصفات. لا يتم جلب الملفات الخارجية أو مراجع URL وتظهر كنتائج مراجعة. تتم مقارنة المخططات العودية عند حدوثها لأول مرة ويتم وضع علامة عليها للمراجعة.

ما هو خارج هذا الشيك؟

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

قد تحتاج أيضًا