更改swagger 2.0文档pathurl
这就是我configurationswagger的方法:
const openapi = Openapi.initialize({ paths: openApiPaths, app, apiDoc, }); const openApiSpec = openapi.apiDoc; console.log(openApiSpec); app.use(swaggerUI(openApiSpec));
我如何更改基本path/docs/
to /projectName/docs/
?
我没有find任何相关的答案
编辑
我的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) => {}
Swagger在一个名为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是doc的path{}部分。 它由目录和文件名构成
最后在快速应用程序:
await openapiSetup.init(app);
你有什么YAML? 应该能够通过修改来更新你的path:
# 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" } }