网站

 

Install

npm install apidoc -g

 

Run

apidoc -i myapp/ -o apidoc/ -t mytemplate/ 没有模板

apidoc -i myapp/ -o apidoc/

 

Demo

首先要有个myapp文件夹

里面有一个接口描述（ 详细描述见官网 ）

/**  * @api {post} /company/useList 获取公司员工列表 * @apiName PostCompany * @apiGroup User * @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 对应id的用户没找到 asdfasdf  *  @apiErrorExample {json} Error-Response: *  HTTP/1.1 404 Not Found *  { *   code:1, *   msg:'user not found', *   } *    */ /**  * @api {get} /company/useList 获取公司员工列表 * @apiName GetCompany * @apiGroup User * @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 对应id的用户没找到 asdfasdf  *  @apiErrorExample {json} Error-Response: *  HTTP/1.1 404 Not Found *  { *   code:1, *   msg:'user not found', *   } *    */

 

运行

apidoc -i myapp/ -o apidoc/ 会生成一个文件夹apidoc，里面就是生成的接口页面