javascript - 如何记录现有的 nodejs API？

Question

Node 新手，对多个库做同样的事情感到非常沮丧。我哪儿也不去。

我有现有的 Node + express 应用程序，需要集成 swagger 文档。我发现最有用的线程是 this one .但它只是希望有并行的 api-docs.json 文件。这不是自动生成的。

我想记录 Controller 中的每个 API，并希望生成文档。谁能指出我更好的资源？

Answer 1

最后我能够让它与 swagger-jsdoc 一起工作

步骤

• 添加Swagger-UI包

• 添加 swagger-ui 依赖

  npm install -g swagger-ui

• 在 server.js 文件中配置 swagger

  var swaggerJSDoc = require('swagger-jsdoc');
变种选项= {
Swagger 定义:{
信息:{
title: 'Hello World',//标题(必填)
version: '1.0.0',//版本(必填)
},
},
apis: ['./routes.js'],//API 文档的路径
};
var swaggerSpec = swaggerJSDoc(选项);
app.get('/api-docs.json', function(req, res) {
res.setHeader('Content-Type', 'application/json');
res.send(swaggerSpec);
});
app.use('/api/docs',express.static('./node_modules/swagger-ui/dist'));

• 向您的 Controller 函数添加 swagger 注释

/**
* @ Swagger
* 资源路径:/api
* 描述:所有关于API
*/

/**
* @ Swagger
*/登录:
* 邮政:
* 描述:登录应用
* 产生:
* - 应用程序/json
* 参数:
* - 名称:用户名
* 描述:用于登录的用户名。
* 在:表单数据
* 必填:真
* 类型:字符串
* - 名称:密码
* 描述:用户密码。
* 在:表单数据
* 必填:真
* 类型:字符串
* 回应:
* 200:
* 描述:登录
*/
app.post('/login', function(req, res) {
res.json(req.body);
});

• Swagger 文档位于 http://localhost:3000/api/docs/?url=/api-docs.json