编写接口文档apidoc用法

一、使用 npm install apidoc -g

二、新建一个目录myapp

三、在目录里面编写注释

例如、在myapp目录里新建a文件夹新建c.js（其他后缀名也可以）

	/**
	 * 
	 * @api {get} /company/list 获取公司信息testM
	 * @apiName 获取公司列表testD
	 * @apiGroup All
	 * @apiVersion 0.1.0
	 * @apiDescription 接口详细描述
	 * 
	 * @apiParam {int} pageNum分页大小 
	 * 
	 * @apiSuccess {String} code 结果码
	 * @apiSuccess {String} msg 消息说明
	 * @apiSuccess {Object} data 分页数据封装
	 * @apiSuccess {int} data.count 总记录数
	 * @apiSuccess {Object[]} data.list 分页数据对象数组
	 * @apiSuccessExample Success-Response:
	 *  HTTP/1.1 200 OK
	 * {
	 * code:0,
	 * msg:'success',
	 * data:{}
	 *  }
	 *  
	 *  @apiError All 对应<code>id</code>的用户没找到 asdfasdf 
	 *  @apiErrorExample {json} Error-Response:
	 *  HTTP/1.1 404 Not Found
	 *  {
	 *   code:1,
	 *   msg:'user not found',
	 *   }
	 *   
	 * @param param
	 * @return
	 * @throws Exception
	 * @apiUse result_code
	 */

新建d.js放入公用的 result_code定义

/**
 * @apiDefine result_code
 * @apiSuccess (警告resultCode) {string} 20007 aa啊啊啊啊
 * @apiSuccess (警告resultCode) {string} 20004 bbbbb
 * @apiSuccess (警告resultCode) {string} 11000 ccccc
 * @apiSuccess (警告resultCode) {string} 10021 fdddddddd
 * @apiSuccess (警告resultCode) {string} 10020 eeeeeeeee
 * @apiSuccess (警告resultCode) {string} 10024 ssssccccc
 * @apiSuccess (警告resultCode) {string} 20020 mmmmm
 *
 */

四、apiGroup使用中文

C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core，搜索api_group.js ，会出现两个文件，修改比较大的那个，注释掉//group = group.replace(/[^\w]/g, '_');即可

五、运行命令

apidoc -i myapp/ -o doc [-c ./] -f ".*\.js$" 

六、注意如果乱码

把建的js文件 例如c.js以utf-8保存