apidoc，一個相當不錯的文檔產生器

標籤：

http://apidocjs.com/

 

例子：
myapp目錄下的MyCode.java

/** * * @api {get} /company/list 擷取公司資訊 * @apiName 擷取公司列表 * @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 */@Deprecatedpublic interface MyCode {    void a();}

 

產生html文檔

apidoc -i myapp/ -o apidoc/

 

apidoc，一個相當不錯的文檔產生器