2016-07-15 4 views
0
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.инструменты для разметки узлов: Как загрузить swaggerUi?

ответ

0

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

Вариант 1: Использование Интернет чванство-UI

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

Вариант 2: Настройка чванство-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/. 

Теперь вы должны быть в состоянии увидеть что-то точно так же как online swagger-ui.

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