,可以通过以下步骤实现:
swagger-ui-express
和swagger-jsdoc
模块。可以使用以下命令进行安装:npm install swagger-ui-express swagger-jsdoc
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const swaggerJsdoc = require('swagger-jsdoc');
const app = express();
const swaggerOptions = {
definition: {
openapi: '3.0.0',
info: {
title: 'API Documentation',
version: '1.0.0',
description: 'API documentation using Swagger',
},
servers: [
{
url: 'http://localhost:3000',
},
],
},
apis: ['./routes/*.js'], // 指定包含Swagger注释的路由文件路径
};
swagger-jsdoc
生成Swagger规范对象:const swaggerSpec = swaggerJsdoc(swaggerOptions);
app.get('/swagger.json', (req, res) => {
res.setHeader('Content-Type', 'application/json');
res.send(swaggerSpec);
});
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));
app.listen(3000, () => {
console.log('Server is running on port 3000');
});
现在,你的Express应用程序将同时提供Swagger文档的JSON规范和Swagger UI界面。你可以通过访问http://localhost:3000/swagger.json
来获取Swagger文档的JSON规范,通过访问http://localhost:3000/api-docs
来查看Swagger UI界面。
这种方法可以让你在单个Express应用程序中管理和展示多个Swagger文档,每个文档对应一个不同的路由文件。你可以根据需要添加更多的路由文件,并在swaggerOptions.apis
中指定它们的路径。
腾讯云相关产品和产品介绍链接地址:
领取专属 10元无门槛券
手把手带您无忧上云