2017-10-12 80 views
5

这是我如何配置招摇:变化招摇2.0文档路径URL

const openapi = Openapi.initialize({ 
    paths: openApiPaths, 
    app, 
    apiDoc, 
    }); 
    const openApiSpec = openapi.apiDoc; 

    console.log(openApiSpec); 

    app.use(swaggerUI(openApiSpec)); 

我怎样才能改变基本路径/docs//projectName/docs/

我没有找到任何相关问题的答案

编辑

我的API文档在它自己的文件中描述如下:

export const apiDoc = { 
    'x-express-openapi-additional-middleware': [checkBodyValidity], 
    swagger: '2.0', 
    basePath: '/api/v1', 
    info: { 
    title: 'Documentation Rest API', 
    version: 'v1', 
    }, 
    paths: {}, 
    definitions: {} 
} 

CheckBodyValidity是怎么样的检查请求参数有效性的中间件(与我的问题无关):

export const checkBodyValidity: any = (req, res, next) => {} 

扬鞭被初始化为下面在名为openapiSetup文件:

export async function init(app: any): Promise<any> { 

[...] 

    const openapi = Openapi.initialize({ 
    paths: openApiPaths, 
    app, 
    apiDoc, 
    }); 
    const openApiSpec = openapi.apiDoc; 

    app.use(swaggerUI(openApiSpec)); 

} 

- > openApiPaths是,如果该文档的路径{}的一部分。

await openapiSetup.init(app); 

回答

3

你在你的YAML有什么:这是一个从目录和文件名

最后,在明确的应用程序构建?应该可以通过修改更新您的路径:

# Relative URL to external documentation 
externalDocs: 
    url: /docs 
    description: Find more info here 

更多信息[这里] [1]

编辑:

你尝试添加以下到您apiDoc对象。

export const apiDoc = { 
    'x-express-openapi-additional-middleware': [checkBodyValidity], 
    swagger: '2.0', 
    basePath: '/api/v1', 
    info: { 
    title: 'Documentation Rest API', 
    version: 'v1', 
    }, 
    paths: {}, 
    definitions: {}, 
    externalDocs: { 
    description: "Docs", 
    url: "http://url/projectName/docs" 
    } 
} 
+0

我没有YAML我用招摇2.0,我将有更多的相关信息 –

+0

我更新我的回答 – dzm

+0

在哪个级别做一个地方编辑我的问题“URL:”?与“路径:”相同的级别? –