apidoc生成文档

相关网址

https://apidocjs.com/

https://github.com/apidoc/apidoc

https://nodejs.org/en/

 

安装nodejs

在项目目录下新建apidoc.json

{
  "name": "springmvc",
  "version": "1.0.0",
  "description": "这是一个简单的apidoc的demo",
  "title": "springmvc",
  "url" : "https://api.github.com/v1"
}

 

在Controller标注

/**
     * @api {post} /employee/add 添加员工
     * @apiVersion 1.0.1
     * @apiName employeeAdd
     * @apiGroup 员工
     *
     * @apiParam {int} age=18 年龄
     * @apiParam {String} name 姓名
     * @apiParam  {String} number 工号
     *
     * @apiSuccess {String} code 返回码
     * @apiSuccess {String} result 返回结果
     */

 

执行node命令

apidoc -i src/ -o doc/

 

生成文档