节点上的swagger-tools:如何加载swaggerUi?

时间:2016-07-15 08:49:08

标签: swagger-ui swagger-tools

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: "/",
...
}

但是如何为我的API加载http://petstore.swagger.io/之类的UI。

1 个答案:

答案 0 :(得分:0)

要通过swagger-ui查看api,请执行以下操作之一。

选项1:使用在线swagger-ui

  1. 转到this
  2. 在页面顶部的对话框中,提供swagger-json的网址。在您的情况下,请插入 http://localhost:3001/api-docs 而不是http://petstore.swagger.io/v2/swagger.json(默认情况下可以看到),然后点击探索
  3. 现在你可以看到为你的api生成的swagger-ui。
  4. 选项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/.
    

    现在你应该可以看到与online swagger-ui完全相同的内容。

    与选项1一样,提供swagger-json url并查看生成的swagger-ui。