لا تحب الإعلانات؟ يذهب خالية من الإعلانات اليوم 

مدقق مواصفات OpenAPI / Swagger

بياناتمطور

إعلان · يزيل؟

مدخل

عملية تلقائية

انتاج

جانب العميل

إعلان · يزيل؟

مرشد

مدقق مواصفات OpenAPI / Swagger

تحقق من مواصفات OpenAPI 3.0 أو 3.1 أو Swagger 2.0 الخاصة بك على الفور. الصق YAML أو JSON، واحصل على قائمة منظمة بالأخطاء والتحذيرات مع مسارات مؤشر JSON، وقم بتنسيق مواصفاتك لتوثيق نظيف.

كيف تستعمل

الصق مواصفات OpenAPI أو Swagger الخاصة بك في حقل الإدخال. يكتشف المدقق تلقائيًا ما إذا كانت YAML أو JSON وأي إصدار مواصفات تستخدمه. تعرض النتائج ملخصًا لنقاط النهاية والمخططات والأخطاء والتحذيرات. تتضمن كل مشكلة مسار مؤشر JSON حتى تتمكن من تحديد موقع المشكلة بسرعة.

سمات

دعم متعدد الإصدارات – يتحقق من مواصفات Swagger 2.0 و OpenAPI 3.0.x و OpenAPI 3.1.x
التحقق الهيكلي – يتحقق من الحقول المطلوبة (المعلومات، المسارات، الإصدار)، والأنواع الصحيحة، وهيكل المخطط
التحقق الدلالي – يكتشف معرفات العمليات المكررة، وطرق HTTP غير الصالحة، ومراجع $ref المعطلة، وعدم اتساق معلمات المسار
مسارات الأخطاء – تتضمن كل مشكلة مسار مؤشر JSON لتحديد الموقع بدقة
طباعة أنيقة – إعادة تنسيق مواصفاتك كـ JSON أو YAML نظيف مع مسافات بادئة مناسبة
ملخص المواصفات – نظرة عامة فورية: الإصدار، إجمالي نقاط النهاية، المخططات، الأخطاء، والتحذيرات
عميل 100% – مواصفات واجهة برمجة التطبيقات الخاصة بك لا تغادر متصفحك أبدًا

إعلان · يزيل؟

 التعليمات

ما هو الفرق بين Swagger 2.0 و OpenAPI 3.0؟

كان Swagger 2.0 هو تنسيق مواصفات واجهة برمجة التطبيقات الأصلي الذي طورته SmartBear. عندما تم التبرع بالمواصفات لمبادرة OpenAPI في عام 2015، تمت إعادة تسميتها إلى OpenAPI. قدم الإصدار 3.0 تحسينات كبيرة بما في ذلك دعم أفضل للاستدعاءات الخلفية والروابط والخوادم المتعددة وهيكل مكونات أوضح. التنسيقان غير متوافقين بشكل مباشر.
لماذا تحتاج معرفات العمليات (operationIds) إلى أن تكون فريدة في مواصفات OpenAPI؟

تعمل معرفات العمليات كمعرفات فريدة لكل عملية واجهة برمجة تطبيقات. تستخدمها مولدات التعليمات البرمجية لإنشاء أسماء طرق في مجموعات أدوات تطوير البرامج العميل، وتستخدمها أدوات التوثيق لروابط الارتساء، وتستخدمها أطر عمل الاختبار للإشارة إلى نقاط نهاية محددة. تتسبب معرفات العمليات المكررة في حدوث تعارضات في جميع هذه الأدوات اللاحقة.
ما هو مؤشر JSON وكيف أقرأ مسارات أخطاء التحقق؟

مؤشر JSON (RFC 6901) هو صيغة سلسلة لتحديد قيمة معينة داخل مستند JSON. على سبيل المثال، يشير /paths/~1users/get/parameters/0 إلى المعلمة الأولى لعملية GET /users. الـ ~1 تقوم بتجاوز الشرطة المائلة للأمام في جزء المسار. قراءة هذه المؤشرات تخبرك بالضبط بمكان حدوث خطأ التحقق في مواصفاتك.
هل يجب أن أكتب مواصفات OpenAPI الخاصة بي بتنسيق YAML أم JSON؟

يتم دعم كلا التنسيقين بالكامل وهما متكافئان وظيفيًا. يُفضل YAML بشكل عام للمواصفات المكتوبة يدويًا لأنه أكثر قابلية للقراءة ويدعم التعليقات. JSON أفضل للمواصفات التي تم إنشاؤها بواسطة الآلة والتلاعب البرنامجي. تقبل معظم الأدوات أيًا من التنسيقين، لذا اختر أي تنسيق تجده فريقك أسهل في الصيانة.