apidoc 生成api文档

apidoc 是一个node.js 环境下根据代码注解生成api文档的小东西

所以首先下载node.js

http://www.nodejs.org/

我是win32环境所以下了个

下载好了打开node.js的命令界面

输入 npm install apidoc -g 等会就安装好了

然后新建一个放置api的目录 如果你项目的注解写的符合规范的话也可以直接指定项目路径都行

我是自己指定了一个就叫api

准备一个json文件apidoc.json放到api目录下

内容

{
  "name": "zmn测试API",
  "version": "0.2.0",
  "description": "zmn测试系统API",
  "title": "zmn测试",
  "url" : "http://www.baidu.com",
  "sampleUrl" : "hhttp://www.baidu.com"
}

放入一个java类做测试

public interface test {
	/**
	 * 
	  * @api {post} /phonePayment.aspx zmn测试api
	  * @apiPermission user
	  * @apiDescription 接口描述 zmn测试接口
	  * @apiGroup PAYMENT 我头上有犄角
	  * @apiParam  {String} v   参数
	  * @apiParam  {String} v1  参数1
	  * @apiParam  {String} v2  参数2
	  * @apiParam  {String} v3  参数3
	  * @apiparam  {String} v4  参数4
	  * @apiParam  {String} v5  参数5
	  * @apiSampleRequest /phonePayment.aspx
	  * @apiSuccess {String} r  	 返回值
	  * @apiSuccess {String} r1  	 返回值1
	  * @apiSuccess {String} r2  	 返回值2
	  * @apiSuccess {String} r3  	 返回值3
	  * @apiSuccess {String} r4  	 返回值4
	  * @apiSuccess {String} r5  	 返回值5
	  * @apiSuccessExample {json} Success-Response:
	  *     HTTP/1.1 200 OK
	  *     返回值格式   
	  * @apiError  {String} MSG 	给用户（得）————这是哪个残废还写错字 提示
	  * @apiErrorExample {json} Error-Response:
	  *     HTTP/1.1 200 OK
	  *    逻辑错误返回值格式
	  * @apiVersion 0.2.0
	  */
	//其实这个方法可以没有  
	public String test(String v,String v1,String v2,String v3,String v4,String v5);
	

}

然后再敲一个命令

i 源码位置 o 生成文件位置

然后就生成文档了 大概就长这个样子很easy吧