安装
yarn add swagger-ui-express swagger-jsdoc
- swagger-ui-express 通过 UI 生成文档展示界面
- swagger-jsdoc 通过代码注释,生成 api 的 json 数据
配置
app.js
中添加上
// swagger
const swaggerUi = require('swagger-ui-express');
const swaggerJSDoc = require('swagger-jsdoc');
const app = express();
const swaggerJSDocOptions = {
definition: {
openapi: '3.0.0',
info: {
title: '长乐未央',
version: '1.0.0',
},
},
apis: ['./routes/*.js'], // 包含接口说明、注释的文件路径
};
con...