swagger ui Download - swagger ui UI Source Code Download

swagger ui

شفرة المصدر الأخرى

v5.18.2 Released!

تنزيل

مقدمة

يتيح Swagger UI لأي شخص - سواء كان فريق التطوير الخاص بك أو مستهلكيك النهائي - تصور وتفاعل موارد API دون وجود أي من منطق التنفيذ. يتم إنشاؤه تلقائيًا من مواصفات OpenAPI (المعروفة سابقًا باسم Swagger) ، مع الوثائق المرئية مما يجعل من السهل على تنفيذ النهاية الخلفية الاستهلاك جانب العميل.

عام

؟ هل تريد تسجيل مساهمة سهلة مفتوحة المصدر؟ تحقق من ملصق العدد الأول الجيد لدينا.

؟ ️ هل تبحث عن النسخة القديمة من Swagger UI؟ الرجوع إلى الفرع 2.x.

ينشر هذا المستودع ثلاث وحدات مختلفة من NPM:

Swagger-UI هي وحدة NPM تقليدية مخصصة للاستخدام في تطبيقات صفحة واحدة قادرة على حل التبعيات (عبر WebPack ، Browserify ، إلخ).
Swagger-Ui-Dist هي وحدة خالية من التبعية تتضمن كل ما تحتاجه لخدمة واجهة المستخدم Swagger في مشروع من جانب الخادم ، أو تطبيق صفحة واحدة لا يمكنه حل تبعيات وحدة NPM.
يتم تعبئة Swagger-Ui-React مع تعبئة واجهة المستخدم كمكون رد فعل للاستخدام في تطبيقات React.

نقترح بشدة أن تستخدم swagger-ui بدلاً من swagger-ui-dist إذا كنت تقوم ببناء تطبيق من صفحة واحدة ، نظرًا لأن swagger-ui-dist أكبر بكثير.

إذا كنت تبحث عن HTML/JS/CSS عادي ، فقم بتنزيل أحدث إصدار ونسخ محتويات مجلد /dist إلى الخادم الخاص بك.

التوافق

خضعت مواصفات OpenAPI 5 مراجعات منذ الإنشاء الأولي في عام 2010. التوافق بين واجهة المستخدم Swagger ومواصفات OpenAPI كما يلي:

نسخة Swagger واجهة المستخدم	تاريخ الافراج عنه	توافق المواصفات Openapi	ملحوظات
5.0.0	2023-06-12	2.0 ، 3.0.0 ، 3.0.1 ، 3.0.2 ، 3.0.3 ، 3.1.0	علامة v5.0.0
4.0.0	2021-11-03	2.0 ، 3.0.0 ، 3.0.1 ، 3.0.2 ، 3.0.3	علامة v4.0.0
3.18.3	2018-08-03	2.0 ، 3.0.0 ، 3.0.1 ، 3.0.2 ، 3.0.3	علامة V3.18.3
3.0.21	2017-07-26	2.0	علامة V3.0.21
2.2.10	2017-01-04	1.1 ، 1.2 ، 2.0	علامة V2.2.10
2.1.5	2016-07-20	1.1 ، 1.2 ، 2.0	علامة V2.1.5
2.0.24	2014-09-12	1.1 ، 1.2	علامة V2.0.24
1.0.13	2013-03-08	1.1 ، 1.2	علامة V1.0.13
1.0.1	2011-10-11	1.0 ، 1.1	علامة V1.0.1

تحليلات مجهولة

يستخدم Swaggerui وشاح لجمع تحليلات التثبيت مجهولة الهوية. تساعد هذه التحليلات في دعم المشرفين في هذه المكتبة ويتم تشغيلها فقط أثناء التثبيت. لإلغاء الاشتراك ، يمكنك تعيين حقل scarfSettings.enabled على false في package.json مشروعك. json:

 // package.json
{
  // ...
  "scarfSettings": {
    "enabled": false
  }
  // ...
}

بدلاً من ذلك ، يمكنك تعيين البيئة المتغيرة SCARF_ANALYTICS على false كجزء من البيئة التي تقوم بتثبيت حزم NPM الخاصة بك ، على سبيل المثال ، SCARF_ANALYTICS=false npm install .