2017-10-12 69 views
5

Bu benim havalı yapılandırmak nasıl?Değişim swagger 2.0 docs yol 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 bir türüdür:

Ben

Benim api doc o kendi dosyasında aşağıdaki gibi açıklanmıştır o

EDIT'e ilgili herhangi bir cevap bulamadık kontrol istekleri paragraf geçerliliği (soru için geçerli değil):

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

Swagger openapiSetup adlı bir dosyada aşağıda başlatılır:

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 doc eğer yol {} parçasıdır. Eğer YAML ne var

await openapiSetup.init(app); 

cevap

3

: Bu dizinleri ve son olarak ekspres uygulamasında

dosya adları inşa ediyor? değiştirerek yolu güncellemek gerekir: [burada]

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

Daha fazla bilgi [1]

Düzenleme:

Eğer apiDoc nesnesine aşağıdaki eklemeyi deneyin yaptı.

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

Bir YAML yoktur ve ben havalı 2.0 kullanmaktadır daha infos benim tepkisini –

+0

ile benim soruyu düzenlemek edeceğiz "url:" "Yollar" ile aynı seviye? – dzm

+0

hangi düzeyde bir yer yapmak güncellenmiş –