node.jsAPI文档生成工具

全局安装

npm i apidoc -g

vscode安装 ApiDoc Snippets

接口上面
apiDocumentation生成注释

/**
 * 
 * @api {post} /api/user 添加用户
 * @apiName addUser添加用户
 * @apiGroup 用户
 * @apiVersion  1.0.0
 * 
 * 
 * @apiParam  {String} username 用户名
 * @apiParam  {String} password 密码
 * @apiParam  {Number} age 年龄
 * @apiParam  {File} avatar 头像文件
 * 
 * @apiSuccess (200) {Numbner} ok 标识成功字段
 * @apiSuccess (200) {Boolean} success 标识成功字段
 * @apiSuccess (200) {String} msg 说明
 * 
 * @apiParamExample  {multipart/form-data} Request-Example:
 * {
 *     username : "Wzx",
 *     password : "123",
 *     age : 123,
 *     avatar : File
 * }
 * 
 * 
 * @apiSuccessExample {type} Success-Response:
 * {
 *     ok : 1,
 *     success : true,
 *     msg : "添加成功",
 * 
 * }
 * 
 * 
 */

router.post('/', upload.single("avatar"), userController.addUser)

生成文档

apidoc -i 目标文件夹 -o 输出文件夹
apidoc -i .\routes\ -o .\doc\

apidoc配置文件

项目中新建apidoc.json

{
  "name": "接口文档",
  "version": "1.0.0",
  "description": "xxx接口文档",
  "title": "接口文档"
}