swagger怎么生成接口文档

Swagger是一种API文档规范和工具，可以帮助我们生成易于阅读和理解的API文档，下面是使用Swagger生成接口文档的步骤：

1. 安装Swagger

可以使用npm或yarn来安装Swagger：

npm install -g swagger
# 或者
yarn global add swagger

2. 创建Swagger配置文件

在项目根目录下创建一个swagger.yaml或swagger.json的文件，用于定义API的接口和参数信息。具体的配置方法可以参考Swagger的官方文档。

3. 编写API代码和注释

在API的代码中，使用Swagger的注释规范来描述API的接口和参数信息。例如，在Node.js中，可以使用swagger-jsdoc模块来实现：

/**
 * @swagger
 * /api/users:
 *   get:
 *     tags:
 *       - Users
 *     description: Returns all users
 *     produces:
 *       - application/json
 *     responses:
 *       200:
 *         description: An array of users
 *         schema:
 *           type: array
 *           items:
 *             $ref: '#/definitions/User'
 */
app.get('/api/users', function(req, res) {
  res.json([{ name: 'Alice' }, { name: 'Bob' }]);
});

4. 生成接口文档

使用Swagger命令行工具生成接口文档：

swagger ./swagger.yaml

生成的接口文档默认会在http://localhost:8080/docs路径下访问。你也可以使用其他的命令行选项来定制文档的生成方式。