Node server生成Swagger接口文档步骤详解-牛翰网

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

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

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

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

例如：

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

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

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：

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。

以上就是Node server生成Swagger接口文档步骤详解的详细内容，更多关于Node server生成Swagger文档的资料请关注脚本之家其它相关文章！

来源链接：https://www.jb51.net/javascript/3128767z8.htm

本站所有资源来自于网络，仅供学习与参考，请勿用于商业用途，否则产生的一切后果将由您(转载者)自己承担！
如有侵犯您的版权，请及时联系3500663466#qq.com(#换@)，我们将第一时间删除本站数据。

THE END

node.js 前端开发编程开发
# Server # node # 生成 # swagger