1. 先安装node.js环境
查看是否安装了node.js,控制台输入node -v
2.安装apidoc:npm install apidoc –g
查看是否安装成功:apidoc -h
3.把新建apidoc,放到项目的根路径
{ "name": "XXAPP文档 ", "version": "2.0.0", "description": "XXAPP文档 2019-11-01", "title": "demo", "url": "http://192.168.0.XXX:9000", "sampleUrl": "http://192.168.0.XXX:9000/" }4.注释,例子
/** * @api {post} /address/editAddress 16.添加&修改地址 * @apiGroup user * @apiHeader {String} token token * @apiParam {String} name 姓名 * @apiParam {String} mobile 手机 * @apiParam {String} streetCode 街道编号(id) * @apiParam {String} detail 地址详情 * @apiSuccess {String} flag 状态:true是成功,false是失败 * @apiSuccess {String} code 状态码 * @apiSuccess {String} message 消息 * @apiSuccess {Object} data 结果集 * @apiHeaderExample {json} Request-Example:返回数据例子 * { * "flag": true, * "code": 20000, * "message": "添加成功", * "data": "" * } */5.生成文档:apidoc -i apidoc所在的位置 -o 文档生成的位置
