- 首先要确认你的系统安装了
nodejs
,然后执行npm install -g apidoc
即可。 - 配置
apidoc
,在你的项目下创建apidoc.json
文件
{
"name": "测试APIs",
"version": "1.0.0",
"description": "接口测试",
"title": "test APIs",
"url" : "您的接口API访问的地址",
"sampleUrl" : "您的测试接口API的访问地址"
}
- 代码书写过程中,书写注释,注释样例如下
-
/** * @api {post} /api/salesman/login 业务员登录 * @apiGroup salesman * @apiName salesman/login * @apiDescription 业务员登录 * * @apiParam {string} username 业务员手机/姓名 * @apiParam {string} password 密码 * * @apiSuccessExample {json} 登录成功返回: * { * "code": 0, * "msg": "登录成功!", * "data": {"token":"5e429a4bb763fa23bfd233df493c87f1"} * } * */
生成文档,执行如下命令
-
apidoc -i api/ -o public/apidoc/
其中,-i后边的是接口文件的目录所在,-o后边的是输出静态文件的目录所在。
-
运行完后,会在相应目录下生成好静态文件,然后点击index.html就可以看到接口文档啦。