swagger ui
v5.18.2 Released!
Пользовательский интерфейс Swagger позволяет кому -либо - будь то ваша команда разработчиков или ваши конечные потребители - визуализировать и взаимодействовать с ресурсами API, не имея никакой логики реализации. Он автоматически генерируется из вашей спецификации OpenAPI (ранее известной как Swagger), причем визуальная документация облегчает реализацию задней части и потребление на стороне клиента.
? Хотите получить легкий вклад с открытым исходным кодом? Проверьте наш хороший ярлык первого выпуска.
? ️ Ищете старую версию Swagger UI? Обратитесь к филиалу 2.x.
Этот репозиторий публикует три различных модуля NPM:
Мы настоятельно рекомендуем вам использовать swagger-ui вместо swagger-ui-dist если вы создаете одностраничное приложение, поскольку swagger-ui-dist значительно больше.
Если вы ищете простой старый HTML/JS/CSS, загрузите последний выпуск и скопируйте содержимое папки /dist на ваш сервер.
Спецификация OpenAPI претерпела 5 ревизий с момента первоначального создания в 2010 году. Совместимость между пользовательским интерфейсом Swagger и спецификацией OpenAPI заключается в следующем:
| Swagger UI версия | Дата выпуска | OpenAPI Spec совместимость | Примечания |
|---|---|---|---|
| 5.0.0 | 2023-06-12 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | Tag v5.0.0 |
| 4.0.0 | 2021-11-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v4.0.0 |
| 3.18.3 | 2018-08-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v3.18.3 |
| 3.0.21 | 2017-07-26 | 2.0 | Tag v3.0.21 |
| 2.2.10 | 2017-01-04 | 1.1, 1.2, 2,0 | Tag v2.2.10 |
| 2.1.5 | 2016-07-20 | 1.1, 1.2, 2,0 | Tag v2.1.5 |
| 2.0.24 | 2014-09-12 | 1.1, 1.2 | Tag v2.0.24 |
| 1.0.13 | 2013-03-08 | 1.1, 1.2 | Tag v1.0.13 |
| 1.0.1 | 2011-10-11 | 1.0, 1.1 | Tag v1.0.1 |
Swaggerui использует шарф для сбора анонимизированной установки аналитики. Эти аналитики помогают поддержать сопровождающих этой библиотеки и работать только во время установки. Чтобы отказаться, вы можете установить поле scarfSettings.enabled в false в package.json вашего проекта.json:
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
В качестве альтернативы, вы можете установить переменную среду SCARF_ANALYTICS false как часть среды, которая устанавливает ваши пакеты NPM, например, SCARF_ANALYTICS=false npm install .
Вам понадобится JDK версии 7 или выше, как указано здесь https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server
Интеграционные тесты могут быть выполнены локально с помощью npm run e2e - убедитесь, что вы не запускаете DEV -сервер при тестировании!
UB Swagger работает в последних версиях Chrome, Safari, Firefox и Edge.
Чтобы помочь с миграцией, вот известные в настоящее время проблемы с 3.x. Этот список будет регулярно обновляться и не будет включать функции, которые не были реализованы в предыдущих версиях.
collectionFormat является частичной.Пожалуйста, раскрывайте любые вопросы, связанные с безопасностью или уязвимость, отправив электронное письмо по адресу [email protected], вместо того, чтобы использовать трекер публичных проблем.
Swaggerui лицензирован по лицензии Apache 2.0. Swaggerui поставляется с явным файлом уведомления, содержащим дополнительные юридические уведомления и информацию.
