apidoc for windows

下载并安装apidoc

下载64位的nodejs，在windows中安装：
下载地址为：https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi
在cmd中执行命令安装apidoc

 npm install -g apidoc

使用apidoc

1、在需要生成接口文档的目录下新建一个apidoc.json

{   
  "name": "example",   
  "version": "0.1.0",   
  "description": "example",  
  "title": "title",   
  "url" : "http://www.test.com"
}

apidoc.json中常见的配置项：

• name 工程名
• version 工程文档的版本号
• description 工程详细描述
• title 文档标题
• url 整个api url的前缀

2、新建一个java文件：

/**
 * @api {post} /user 中文
 * @apiName obj
 * @apiParam {Object} person 
 * @apiParam {String} person.name  姓名 
 * @apiParam {Integer} person.age 年龄 
 */

在cmd中使用cd切换到生成doc的目录，执行apidoc生成文档。
命令为：

apidoc

3、apidoc参数说明：

参数	描述
-i	选择源代码所在位置
-o	选择生成的目标文件所在的位置

常用命令：

apidoc -i com/src/ -o out/
apidoc -h