الصفحة الرئيسية>موارد بناء الموقع>موارد أخرى
تنزيل

Openapi-Gui

Openapi-Gui هو واجهة المستخدم الرسومية لإنشاء وتحرير OpenAPI الإصدار 3.0.x JSON/YAML تعريفات. في شكله الحالي ، يعد الأمر مفيدًا كأداة لبدء تعريف تعريفات OpenAPI البسيطة وتحريرها. يتم تحويل تعريفات OpenAPI 2.0 المستوردة تلقائيًا إلى V3.0.

للحصول على نسخة Swagger / OpenAPI 2.0 فقط انظر هنا. لا يتم حاليًا صيانة هذا الإصدار بصرف النظر عن إصلاحات الأمان.

كان هذا المشروع في البداية شوكة من Daryl Kuhn's Iodoctor ، والتي بدورها كانت مستوحاة من Iodoctor من قبل براندون ويست التي كتبها روبي. يتم الحفاظ على التاريخ الكامل للمشروع على جيثب.

وصف

كيف تعمل

حدد تعريف OpenAPI 2.0 أو 3.0.x موجود لتحميل أو إنشاء تعريف جديد وابدأ في إضافة مسارات وعمليات ومعلمات. عند استخدام تعريف موجود ، يتم تحليله وسيتم إنشاء نماذج لتحرير كل مسار ، والتشغيل والمعلمة.

يمكنك تحميل تعريف موجود عن طريق إلحاق معلمة ?url= Query إلى صفحة البدء الأولية مع القيمة هي عنوان URL إلى التعريف الذي ترغب في تحميله. عند استخدام Docker ، يمكنك تعيين قيمة معلمة Query url إلى %2fserve لالتقاط التعريف الذي مررت به على خط الأوامر Docker.

انقر فوق عنصر من القائمة على اليسار لبدء التحرير. عرض إخراج JSON/YAML في أي وقت عن طريق تحديد واحدة من علامات التبويب "التصدير". عند الانتهاء ، قم بتنزيل الإخراج لحفظه محليًا أو نسخه للحافظة. يخزن Openapi-Gui تعريفًا واحدًا فقط في وقت واحد ، وهذا في التخزين المحلي للمتصفح. تأكد من حفظ إخراج JSON/YAML محليًا.

قبل القيام بعمل مدمر ، يحفظ Openapi-Gui الوضع الحالي للتعريف. في جميع الأوقات الأخرى ، يجب أن تتذكر تحديد الحفظ يدويًا.

تكنولوجيا

يعمل Openapi-Gui على تشغيل جانب العميل بالكامل باستخدام عدد من أطر عمل JavaScript بما في ذلك Vue.js و JQuery و Bulma لـ CSS.

للحصول على التطبيق وتشغيله ، فقط تصفح إلى الإصدار المباشر على صفحات github ، أو نشر استنساخ على صفحات github ، أو النشر إلى Heroku باستخدام الزر أدناه ، أو استنساخ الريبو وتوجيه المتصفح في index.html أو استضافته بنفسك - لا يمكن أن يكون أبسط. المزيد من المعلومات الفنية هنا.

تحتاج فقط إلى npm install إذا كنت ترغب في استخدام خادم الويب المدمج openapi-gui (أي ليس إذا كنت تقوم بتشغيل خادم الويب الخاص بك) ، وإلا فهي موجودة فقط لنشر PAAS.

خيارات CLI 

 -d, --definition    serve the given OAS definition
-l, --launch        start a web-browser pointing to the GUI
-p, --port          specify the port to run on, defaults to $PORT or 3000
-w, --write         enable writing back to the source definition

الجري مع Docker

إذا لم يكن لديك بيئة تطوير عقدة محلية ، أو إذا كنت تفضل تشغيل OpenAPI-Gui في حاوية Docker ، فيمكنك القيام به مع بعض الخطوات البسيطة:

  1. استنساخ المستودع.
  2. تشغيل docker build -t mermade/openapi-gui . لبناء صورة Docker ( mermade/openapi-gui )
  3. Run docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui لتشغيل الخادم على المنفذ 8080.
  4. انتقل إلى http://localhost:8080 في متصفحك المفضل.
  5. عند الانتهاء ، قم بإغلاق الخادم عن طريق تشغيل docker stop openapi-gui && docker rm openapi-gui

أو يمكنك سحب صورة Docker مسبقًا:

  • docker pull mermade/openapi-gui

القيود

  • سوف Openapi-Gui إلغاء تحديد المعلمات المشتركة.
  • يجب أن يكون التعريف مكتفية ذاتيًا بدون أي $ref s. من المحتمل أن يتم حل هذا (Ho-Ho) قريبًا .
  • تحرير استجابة / مثال / مخطط الجسم سيؤدي إلى إبطال ذلك.
  • لن يحافظ Openapi-Gui دائمًا على مواد البائعين ، على سبيل المثال ، إذا تم حذف المعلمة وإعادة إنشائها.
  • لن يحافظ Openapi-Gui على تعليقات من التعاريف المستوردة بتنسيق Yaml.

تودو

  • راجع قائمة TODO والوضع الحالي لدعم مواصفات OpenAPI 3.0.
يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل