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

@powerduck/oas-document

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

  • اسم الحزمة: @powerduck/oas-document
  • الإصدار:
  • الترخيص: MIT

المكتبات المستخدمة: @powerduck/openapi-parser (التحقق والتحويل التلقائي), @powerduck/tree (التنقل), @powerduck/md-editor (عرض Markdown), @powerduck/openapi-codegen (إنشاء شيفرة الطلبات).

الميزات​

  • توثيق API جاهز للإدراج — يقبل كائنًا محللًا أو سلسلة JSON أو سلسلة YAML
  • تخطيط بأسلوب Stripe — ترويسة قابلة للتخصيص وشجرة جانبية وعرض للعمليات بعمودين
  • سمتان فاتحة وداكنة — التبديل من الترويسة مع حفظ الاختيار في localStorage
  • التحويل التلقائي إلى OAS 3.2 — التحقق والتحويل عبر @powerduck/openapi-parser
  • تنقل متزامن مع التمرير — مستمع تمرير سلبي مع بحث ثنائي
  • عرض Markdown — عرض الأوصاف عبر @powerduck/md-editor
  • أمثلة شيفرة بلغات متعددة — تُنشأ عبر @powerduck/openapi-codegen
  • استكشاف المخططات — جداول خصائص متداخلة قابلة للتوسيع والطي
  • تخطيط متجاوب — يتحول الشريط الجانبي على الأجهزة المحمولة إلى لوحة متراكبة

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