2017-10-12 33 views
5

यह कैसे मैं अकड़ कॉन्फ़िगर है?बदलें अकड़ 2.0 डॉक्स पथ यूआरएल

मुझे लगता है कि

संपादित

मेरे एपीआई दस्तावेज़ को उसकी अपनी फ़ाइल में नीचे के रूप में वर्णन किया गया है करने के लिए किसी भी प्रासंगिक उत्तर नहीं मिलता:

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 का उपयोग, मैं अधिक infos –

+0

मैं अपने प्रतिक्रिया – dzm

+0

जो स्तर पर एक जगह कर अद्यतन के साथ मेरे सवाल को संपादित करेंगे "Url:" "पथ:" के समान स्तर? –

संबंधित मुद्दे