apiDoc 入門

網站

http://apidocjs.com/#demo

 

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 對應<code>id</code>的用戶沒找到 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 對應<code>id</code>的用戶沒找到 asdfasdf 
 *  @apiErrorExample {json} Error-Response:
 *  HTTP/1.1 404 Not Found
 *  {
 *   code:1,
 *   msg:'user not found',
 *   }
 *   
 */

 

運行

apidoc -i myapp/ -o apidoc/

會生成一個文件夾apidoc，里面就是生成的接口頁面