swagger-tools на узле: Как загрузить swaggerUi?

Question

When I hit http://localhost:3001/api-docs loads the swagger json docs.

{
swagger: "2.0",
info: {
version: "1.0.0",
title: "Auth-gateway services",
contact: {
name: "swagger docs",
url: "https://www.google.com"
}
},
host: "127.0.0.1:3001",
basePath: "/",
...
}

Но как мне загрузить пользовательский интерфейс, например http://petstore.swagger.io/ для моих API?

Answer 1

Чтобы просмотреть API через swagger-ui, выполните одно из следующих действий.

Вариант 1. Использование онлайн-сваггера

1. Иди к этому.
2. В диалоговом окне вверху страницы укажите URL для swagger-json. В вашем случае вставьте http://localhost:3001/api-docs вместо http://petstore.swagger.io/v2/swagger.json (который можно увидеть по умолчанию) и нажмите " Исследовать".
3. Теперь вы можете увидеть сгенерированный Swagger-UI для вашего API.

Вариант 2: локальная настройка проекта swagger-ui

Вы должны настроить Swagger-UI. Вы можете клонировать проект, настроив его с помощью приведенных ниже инструкций.

Windows Users: Please install Python before follow below guidelines
for node-gyp rebuild to run.

1. npm install
2. npm run build
3. You should see the distribution under the dist folder. Open ./dist/index.html to launch Swagger UI in a browser

Development

Use npm run serve to make a new build, watch for changes, and serve the result at http://localhost:8080/.

Теперь вы должны увидеть что-то похожее на онлайн-сваггер.

Сделайте то же самое, что и в варианте 1, чтобы предоставить URL-адрес swagger-json и увидеть, как генерируется swagger-ui.