Как запустить swagger ui локально?

Пользователь

от ciara , в категории: Другие , год назад

Как запустить swagger ui локально?

Facebook Vk Ok Twitter LinkedIn Telegram Whatsapp

2 ответа

Пользователь

от josie , год назад

@ciara 

Для того чтобы запустить Swagger UI локально, вам нужно:

  1. Скачать последнюю версию Swagger UI с GitHub или npm.
  2. Распакуйте архив со Swagger UI в локальную директорию.
  3. Откройте файл index.html в вашем браузере.


По умолчанию Swagger UI будет открыт на http://localhost:8080, но вы можете изменить это, отредактировав строку defaults.url в файле index.html.


Пример:

1
2
3
4
const ui = SwaggerUIBundle({
  url: "http://localhost:8080/openapi.yaml",
  ...
});


Сваггер будет читать OpenAPI документ по указанному URL. Если вы хотите загрузить OpenAPI документ из файла, вы можете использовать параметр spec:

1
2
3
4
const ui = SwaggerUIBundle({
  spec: myApiSpec,
  ...
});


Пользователь

от gage , 7 месяцев назад

@ciara 

Для запуска Swagger UI локально вы можете использовать контейнеры Docker или установить его непосредственно на свой сервер.


Способ 1: Запуск через Docker

  1. Установите Docker, если у вас его нет.
  2. Склонируйте официальный репозиторий Swagger UI с GitHub или скачайте его архив.
  3. Перейдите в директорию, содержащую файл Dockerfile.
  4. Соберите Docker-образ, выполнив команду: docker build -t swagger-ui .
  5. Запустите контейнер, выполнив команду: docker run -p 8080:8080 swagger-ui Здесь -p 8080:8080 перенаправляет порт контейнера на порт хоста 8080. Если хотите использовать иной порт, измените порт хоста.
  6. Откройте свой браузер и введите http://localhost:8080 для доступа к Swagger UI.


Способ 2: Установка на сервер

  1. Склонируйте официальный репозиторий Swagger UI с GitHub или скачайте его архив.
  2. Перейдите в каталог с загруженным Swagger UI.
  3. Запустите локальный сервер для этого каталога. Например, используйте команду: python -m http.server Если у вас установлен Python 2, ко***** может выглядеть так: python -m SimpleHTTPServer Это запустит сервер на порту 8000. Если вам нужно использовать другой порт, укажите его после команды сервера, например python -m http.server 8080.
  4. Откройте свой браузер и введите http://localhost:8000 (или другой выбранный вами порт) для доступа к Swagger UI.


Примечание: Перед запуском Swagger UI убедитесь, что у вас есть файлы OpenAPI/Swagger для загрузки или указываете соответствующую ссылку на сервере Swagger, чтобы отобразить API.