إنتقل إلى المحتوى الرئيسي

@powerduck/openapi-parser

حوّل أي مستند Swagger 2.0 أو OpenAPI 3.0 أو 3.1 أو 3.2 إلى OpenAPI 3.2 باستدعاء واحد.

غلاف خفيف حول المكتبتين التاليتين: @scalar/openapi-parser, @scalar/openapi-upgrader. لا يعيد تنفيذ التحليل أو التحقق أو التحويل، بل يربطها معًا ويعطي كل إخفاق بنية موحدة ومتوقعة مع رمز خطأ قابل للقراءة آليًا.

  • اسم الحزمة: @powerduck/openapi-parser
  • الإصدار:
  • الترخيص: MIT
  • Node.js: >= 22.12.0

الميزات​

  • دالة واحدة لجميع الإصدارات — تُحوَّل مستندات Swagger 2.0 وOpenAPI 3.0.x و3.1.x و3.2.x إلى مستند 3.2 تم التحقق منه.
  • إدخال سلاسل JSON وYAML — مرّر كائنًا سبق تحليله أو سلسلة JSON/YAML خامًا.
  • رموز أخطاء قابلة للقراءة آليًا — يظهر كل إخفاق على هيئة OpenApiUpgradeError يتضمن قيمة من تعداد UpgradeErrorCode.
  • دون تعديل الإدخال — تُنسخ المدخلات نسخًا عميقًا عبر structuredClone قبل بدء أي مرحلة تحويل.
  • حماية من المراجع الدائرية — يكتشف الدورات في الإدخال قبل أن تسبب تجاوز سعة المكدس.
  • التحقق من المخرجات — يُتحقق افتراضيًا من مطابقة مستند 3.2 الناتج للمخطط.
  • دعم ESM وCJS — استخدم import في Node الحديث وأدوات التجميع، وrequire() في عملية Electron الرئيسية.

الخطوات التالية​

  • التثبيت — التثبيت والمتطلبات
  • البدء السريع — تحويل مستندك الأول
  • مرجع API — جميع الصادرات ورموز الأخطاء والخيارات
  • أمثلة — معالجة الأخطاء والخيارات والاستخدام مع CommonJS