Node server生成Swagger接口文档步骤详解

npm install swagger-jsdoc swagger-ui-express --save

/**
 * @swagger
 * /users:
 *   get:
 *     description: 返回用户列表
 *     responses:
 *       200:
 *         description: 成功获取用户列表
 */
app.get('/users', (req, res) => {
  // ...
});

const swaggerJSDoc = require('swagger-jsdoc');
const swaggerDefinition = {
  openapi: '3.0.0',
  info: {
    title: 'Express API with Swagger',
    version: '1.0.0',
  },
  servers: [
    {
      url: 'http://localhost:3000',
      description: 'Development server',
    },
  ],
};

const options = {
  swaggerDefinition,
  // 路径到API文档的地方
  apis: ['./routes/*.js'], // e.g. assuming your routes are in a directory called "routes"
};

const swaggerSpec = swaggerJSDoc(options);

const swaggerUi = require('swagger-ui-express');

// 在你的应用中设置路由服务Swagger文档
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));