2017-10-12 92 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:」?與「路徑:」相同的級別? –