2017-07-07 243 views
1

我正在使用Swagger Editor Docker图像来定义我的API规范,并生成一个nodejs服务器以作为存根API运行并为我的API规范提供文档。更改Swagger UI中的默认API规范URL

我想知道是否可以将默认网址更改为我自己的,以便在打开网页时显示我的规范,以及我将如何执行此操作。

enter image description here

举例来说,我想更改默认地址http://localhost:8080/spec

回答

1

如果我理解正确的,你用扬鞭代码生成,生成的Node.js服务器。现在当您使用npm start并打开Swagger UI时,您希望输入框(spec URL)显示为http://localhost:8080/spec而不是http://localhost/api-docs

要更改.yaml规范是从服务的路径,编辑您index.js如下:

// 1 - add swaggerUi options 
var uiOptions = { 
    apiDocs: '/spec' // <-- override the default /api-docs 
}; 

swaggerTools.initializeMiddleware(swaggerDoc, function (middleware) { 
    ... 

    // 2 - pass these options to swaggerUi 
    app.use(middleware.swaggerUi(uiOptions)); 

的端口号是由serverPort变量指定在index.js

var serverPort = 8080;