本文介绍使用NodeJs搭建的后端server快速生成Swagger接口文档的技巧。将Node.js服务器的路由信息转换成Swagger（现称OpenAPI Specification）格式的步骤通常如下：

安装必要的Node.js库 ：首先，需要在Node.js项目中安装Swagger相关的库。一个常用的库是swagger-jsdoc，它可以根据JSDoc注释自动创建Swagger文档。同时，swagger-ui-express可以用来在你的Express应用中提供一个可视化的Swagger UI。
bash 复制代码
```
npm install swagger-jsdoc swagger-ui-express --save
```

添加JSDoc注释 ：在路由处理器中使用JSDoc注释来描述API。swagger-jsdoc将使用这些注释生成Swagger文档。

例如：

javascript 复制代码

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

配置swagger-jsdoc ：在应用程序中配置swagger-jsdoc，以便能够收集所有的JSDoc注释并生成Swagger文档。

javascript 复制代码

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);

使用swagger-ui-express为Swagger文档提供UI：

javascript 复制代码

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

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

运行你的应用并访问Swagger UI ：当运行Node.js应用时，可以访问http://localhost:3000/api-docs（或配置的其他地址）来查看和测试API。

English version

The steps to transform the routing information of a Node.js server into Swagger (now known as OpenAPI Specification) format are typically as follows:

Install Necessary Node.js Libraries : First, necessary Swagger-related libraries need to be installed in the Node.js project. A commonly used library is swagger-jsdoc, which can automatically create Swagger documentation based on JSDoc comments. Additionally, swagger-ui-express can be used to provide a visual Swagger UI in an Express application.
bash 复制代码
```
npm install swagger-jsdoc swagger-ui-express --save
```

Add JSDoc Comments : Use JSDoc comments to describe the API in the route handlers. swagger-jsdoc will use these comments to generate Swagger documentation.

For example:

javascript 复制代码

/**
 * @swagger
 * /users:
 *   get:
 *     description: Returns a list of users
 *     responses:
 *       200:
 *         description: Successfully retrieved list of users
 */
app.get('/users', (req, res) => {
  // ...
});

Configure swagger-jsdoc : Configure swagger-jsdoc in the application to collect all JSDoc comments and generate Swagger documentation.

javascript 复制代码

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,
  // Path to the API docs
  apis: ['./routes/*.js'], // e.g. assuming your routes are in a directory called "routes"
};

const swaggerSpec = swaggerJSDoc(options);

Use swagger-ui-express to Provide UI for Swagger Documentation:

javascript 复制代码

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

// Set up a route in your application to serve the Swagger documentation
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));

Run Your Application and Access Swagger UI : Now, when running the Node.js application, the Swagger UI can be accessed at http://localhost:3000/api-docs (or another configured address) to view and test the API.

Remember to replace the paths and information in the example with those in the actual application. The above steps require some manual work in the code, but once completed, a real-time updated API documentation is obtained, which is very convenient for API testing and collaborative work.

Node server生成Swagger接口文档

English version