nodejs中的一个模块
通过这个模块,基于注释,快速生成接口文档
1、下载模块,通过命令基于注释生成文档
npm install apidoc -g
2、在项目根目录创建apidoc.json文件
{
"name": "后台管理系统接口文档",
"version": "1.0.0",
"description": "apiDoc basic example",
"title": "Custom apiDoc browser title",
"url" : "http://localhost:3000/v1"
}
3、写接口注释controller/stu.js
/**
* @api {get} /stu 学生列表
* @apiName Add
* @apiGroup Stu
*
* @apiParam {Number} pageIndex 当前页
* @apiParam {Number} pageSize 每页显示条数
*
* @apiSuccess {String} meta 状态码&提示信息
* @apiSuccess {String} data 数据
*/
4、生成接口文档
apidoc -i ./接口注释目录 -o ./接口文档存放目录
apidoc -i ./controller -o ./docs