2017-10-12 16 views
5

は、これは私が闊歩を設定する方法ですか?変更闊歩2.0ドキュメントのパスのURL

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がの一種である:

私は

私のAPIドキュメントは、それ自身のファイルに以下のように記述されている

EDITに関連するすべての答えを見つけることができませんでした(私の質問には関係ありません):

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)); 

} 

- DOC場合> 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

で私の質問を編集しましょう「のURLを:」? "paths:"と同じレベルですか? – dzm

+0

どのレベルで場所を行い、更新 –