APIDOC快速指南
- 官网getting-started文档链接 http://apidocjs.com/#getting-started
- 官网参数说明文档链接 http://apidocjs.com/#params
PS:解决@apiGroup和不支持中文:
复制api_name.js 和 api_group.js到此目录并替换
C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers
apidoc注解模板
Usage
- Open Eclipse
- Go to Window > Preferences > Editor > Templates
- Click the
Import...
button - Select
api_doc_templates.xml
file - Click the
Open
button
Screenshot
3.实例:
命令行中npm命令安装apidoc
npm install apidoc -g
安装成功后生成文档只要三步:
1、编写JAVA项目的注解
编写JAVA项目的注解
/**
* @api {post} /message/send 发送消息
* @apiGroup Message
* @apiName Push Message
* @apiParam {String} message 消息,必填
* @apiParam {String} fromUserId 发送人ID,必填
* @apiParam {String} toUserId 接收人ID,必填
* @apiParam {String} sign 签名,必填
* @apiParam {String} timestamp 请求时间,必填
*
*
* @apiSuccess (200) {String} code 200
* @apiSuccessExample {json} Success-Response:
* HTTP/1.1 200 OK {
* "result":{"code": 200},"httpCode":200
*}
*
* @apiVersion 0.1.0
*/
注解对应效果如下图:
2、在编译注解成文档之前,需要配置全局变量apidoc.json。apidoc.json配置后放在项目根目录。
apidoc.json,放在项目根目录
{
"name": "教育家Link API",
"version": "0.1.0",
"description": "教育家Link API",
"title": "教育家Link API",
"url" : "http://test.link.iedu.tech"
}
3、切换到项目的上级目录执行编译命令
命令行中npm命令安装apidoc
apidoc -i myapp/ -o apidoc/
myapp/是项目文件夹名称
apidoc/就生成的apidoc文件夹名称