lee 1710 0 2017-07-04 11:05:45

文章位置:左搜> 编程技术> 正文
java编程中使用nodejs的apidoc工具生成Java api文档,apidoc可以根据代码注释生成web api文档,支持大部分主流语言
1.下载安装nodejs环境,(已安装请忽略)
下载地址:http://nodejs.cn/download/
如果不是很会,推荐下载msi文件格式的,会自动集成到系统中
2.安装apidoc工具
弹出:cmd窗口输入以下命令安装:
npm install apidoc -g
3.创建一些配置和文件夹
 创建一个存放Java源代码的文件夹myapp
 创建一个存放生成api文档的文件夹apidoc
4.创建json配置文件
在存放Java代码的根目录创建apidoc.json
{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title",
  "url" : "https://api.github.com/v1"
}

5.执行命令
apidoc -i pathto/myapp/ -o pathto/apidoc/
6.支持的api注释
注释
java example:
package net.xqlee.example

import net.xqlee.common.pojo.Result;

/**
 *测试DOC
 * 
 * @author xqlee
 *
 */
@RestController
public class Example {

	/**
	 * @apiVersion 1.0.0
	 *
	 * @api {get} /apis/example.json 获取验证码
	 * 
	 * @apiName doexample
	 * 
	 * @apiGroup exampleGroup
	 * 
	 * @apiPermission none
	 * 
	 * @apiParam {String} [timeStamp] 时间戳
	 * @apiParam {String} timeStamp2 时间戳2
	 * 
	 * @apiSuccessExample {json} 成功返回值: 
	 * {
			"id": "1be34f4a324c4123b0325ecf0593d70e",
			"data": {
				"image": "iVBORwCCAAAAAAAAAAAAAAAAA=="
			},
			"code": "00000",
			"dateTime": "2017-05-23 14:00:23",
			"msg": null
		}
	 * @apiErrorExample {json} 失败返回值:
	 *{
			"id": "1be34f4a324c4123b0325ecf0593d70e",
			"data": "",
			"code": "EEEEE",
			"dateTime": "2017-05-23 14:00:23",
			"msg": "系统异常"
		}
	 */
	@GetMapping("/apis/validation/getcode.json")
	public Result example(String name,String sex) {
		
		return "{}";

	}
}

7.其他参数参考
http://apidocjs.com/#params