gpt4 book ai didi

node.js - 在 Node js 中使用多个 api 文档来 Swagger ?

转载 作者:搜寻专家 更新时间:2023-11-01 00:34:52 24 4
gpt4 key购买 nike

我已经为一个项目提供了我的 API 版本。所以它有两个文件夹 v1 和 v2,它们有不同的 api。现在,为了实现 v1 和 v2 的 swagger,我在 app.js 中编写了以下代码。

// Swagger definition
// You can set every attribute except paths and swagger
const swaggerDefinition = {
swagger: '2.0',
info: {
// API informations (required)
title: 'API', // Title (required)
version: '1.0.0', // Version (required)
description: 'Used for api documentation', // Description (optional)
},
host: `localhost:3000`, // Host (optional)
basePath: '/v1', // Base path (optional)
};

// Options for the swagger docs
const optionsV1 = {
// Import swaggerDefinitions
swaggerDefinition,
// Path to the API docs
// Note that this path is relative to the current directory from which the Node.js is ran, not the application itself.
apis: ['./app/v1/docs/*.yaml']
};

const optionsV2 = {
// Import swaggerDefinitions
swaggerDefinition,
// Path to the API docs
// Note that this path is relative to the current directory from which the Node.js is ran, not the application itself.
apis: ['./app/v2/docs/*.yaml']
};
optionsV2.swaggerDefinition.basePath = "/v2"
// Initialize swagger-jsdoc -> returns validated swagger spec in json format
const swaggerSpecV1 = swaggerJSDoc(optionsV1);
const swaggerSpecV2 = swaggerJSDoc(optionsV2);
// const swaggerDocument = require('./app/v1/docs/swagger.json');
// app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
app.use('/v1/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecV1));
app.use('/v2/docs', swaggerUi.serve, swaggerUi.setup(swaggerSpecV2));

但是如果我点击 url 作为 /v1/docs/v2/docs 它总是向我显示 v2 的 api 文档。所以这里为 v2 写的最后一行所以它总是只显示 v2 的文档。请建议如何支持多个 api?

最佳答案

这是 Swagger UI 中的已知问题。请使用以下格式路由请求:

var swaggerHtml = swaggerUi.generateHTML(swaggerDocument, swaggerUiOpts)
app.use('/api-docs-html1', swaggerUi.serveFiles(swaggerDocument, swaggerUiOpts))
app.get('/api-docs-html1', (req, res) => { res.send(swaggerHtml) });

更新代码:

var swaggerHtmlV1 = swaggerUi.generateHTML(swaggerSpecV1, optionsV1)
var swaggerHtmlV2 = swaggerUi.generateHTML(swaggerSpecV2, optionsV2)

app.use('/v1/docs', swaggerUi.serveFiles(swaggerSpecV1, optionsV1))
app.get('/v1/docs', (req, res) => { res.send(swaggerHtmlV1) });

app.use('/v2/docs', swaggerUi.serveFiles(swaggerSpecV2, optionsV2))
app.get('/v2/docs', (req, res) => { res.send(swaggerHtmlV2) });

请查看以下链接了解更多详情: https://github.com/scottie1984/swagger-ui-express/issues/65

关于node.js - 在 Node js 中使用多个 api 文档来 Swagger ?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/56018770/

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com