apidoc命令行生成接口文档

原创
05/25 17:14
阅读数 230

安装运行:
node.js中文网下载安装:http://nodejs.cn/
1、安装npm环境
2、运行下载apidoc:npm install apidoc -g
3、在需要生成注释的文件目录增加 “apidoc.json”文件,文件内容如下:

{ 
  "name": "example", 
  "version": "0.1.0", 
  "description": "apiDoc basic example", 
  "title": "Custom apiDoc browser title", 
  "url" : "https://api.github.com/v1",
  "sampleUrl":"xxx"
}

4、运行命令:apidoc
5、运行生成静态接口命令:apidoc -i src -o doc
    说明:src 文档注释读取来源
          doc 文档生成目录
6、在文件夹 docapi中点击 index.html页面,查看接口文档

项目中增加apidoc:
1、新建apidoc文件夹和src同目录
2、apidoc文件夹下增加生成目录doc文件夹 和文件 apidoc.json 
   apidoc.json文件内容:

{ 
  "name": "example", 
  "version": "0.1.0", 
  "description": "apiDoc basic example", 
  "title": "Custom apiDoc browser title", 
  "url" : "https://api.github.com/v1",
  "sampleUrl":"xxx"
}


3、生成命令:进入项目所在目录apidoc文件夹下,执行命令:“apidoc -i ../src -o doc”

idea中自动增加注释:
1、设置模板
    File-Setting- Editor-live Templates
    + Template Group 增加组 doc
    + Live Template 增加模板 apidoc

模板缩写(Abbreviation):设置为 “apicdoc”。
模板描述(Description):设置为 “apidoc方法注释”。
模板内容:添加如下内容

/**
 * @api {get}/api/test.do 这里写方法名称
 * @apiVersion 0.1.0
 * @apiName test
 * @apiGroup 这里写接口分组名称
 * @apiDescription 这里写方法名称
 * @apiParam {String} username 这里是参数信息
 *
 * @apiSuccessExample {json} 成功返回示例
 * { "code": 1, "msg": "操作成功!", "count": 0, "data": { } }
 * @apiErrorExample {json} 失败返回示例
 * { "code": 0, "msg": "操作失败!", "count": 0, "data": null }
 */


2、定义模板的使用范围
点击底部  Define  全选 java栏目
保存结束
3、使用方法:
    在类方法名上面输入 apidoc 按提示选择 “apidoc方法注释”
idea添加注释参考博客: https://blog.csdn.net/liqing0013/article/details/84104419
apidoc参考博客: https://www.jianshu.com/p/774ae227b154
apidoc参考博客:https://www.cnblogs.com/minsons/articles/7154090.html
apidoc官网参考地址: https://apidocjs.com/ 

展开阅读全文
打赏
0
0 收藏
分享
加载中
更多评论
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部