使用apidocJs快速生成在線文檔

https://blog.csdn.net/xialei199023/article/details/63251482

 

https://blog.csdn.net/qq_16142851/article/details/78319768?locationNum=1&fps=1

 

對比下面的兩個例子，對apidoc的文檔參數就有個基本認識了

例子 01

/**
* @api {get} index.php?i= 測試一 * @apiGroup test * @apiVersion 0.0.1 * @apiDescription 這是第一個測試 * @apiParam {String} token 登陸token * @apiParamExample 請求樣例 * /index.php?i=8888 * @apiSuccess {int} type 類型 0：上行 1：下行 * @apiExample 請求成功數據 * { * "status": "1", * "data": { * "first": 1, * "last": 3, * }, * "msg": "操做成功" * } * @apiExample {json} 失敗返回樣例: * {"code":"0","msg":"修改爲功"} */

例子02

/** * @api {POST} /test/:id 測試二 * @apiGroup test * @apiVersion 0.0.1 * @apiDescription 這是第二個測試 * @apiParam {String} name 名字 * @apiParam {String} [phone] 手機 * @apiSuccess (Success) {String} msg 信息 * @apiSuccess (Success) {int} code 0 表明無錯誤 1表明有錯誤 * @apiError (Error) {String} msg 信息 * @apiError (Error) {String} m 信息 * @apiParamExample 請求樣例 * /index.php?i=8888 * @apiSuccessExample {json} 返回樣例 * {"code":"0","msg":"修改爲功"} * @apiErrorExample {json} 失敗返回樣例 * {"code":"0","msg":"修改爲功"} */

apidoc 文檔參數詳細說明

* @apiDeprecated [提示消息] //棄用標誌 若是未指定[]裏面內容{包括中括號}，則下次不產生該接口，若是指定，則輸出提示消息 * @api {POST} /test/:id 測試二 //指定接收方式以及顯示名稱 * @apiGroup //分組 * @apiVersion //版本 * @apiDescription //描述 * @apiParam {String} name 名字 // 參數類型 以及參數名稱 沒有中括號表明必選參數 * @apiParam {String} [phone] 手機 // 參數類型 以及參數名稱 [phone] 表明可選參數 * @apiSuccess (Success) {String} msg 信息 //返回成功數據名稱以及類型 * @apiError (Error) {String} msg 信息 //返回失敗數據名稱以及類型 * @apiParamExample 請求樣例 //示例 * /index.php?i=8888 //例子 * @apiSuccessExample {json} 返回樣例 // 返回成功數據以及指定返回數據格式 * {"code":"0","msg":"修改爲功"} //指定json格式後能夠不用格式化，apidoc 輸出的時候會作作處理 * @apiErrorExample {json} 失敗返回樣例 // 返回失敗數據以及指定返回數據格式 * {"code":"0","msg":"修改爲功"}

tips

01： warn: Please create an apidoc.json configuration file.

檢查你的項目下 有沒有 apidoc.json  //沒有則建立 { "name": "文檔名稱", "version": "0.1.0", //版本號 "description": "apiDoc basic example", // 描述 "title": "Custom apiDoc browser title", // 頭部 "url" : "http://192.168.197.135/" // 項目地址 "sampleUrl" : "http://192.168.197.135/" //接口默認發送的地址 }

02：warn: parser plugin ‘param’ not found in block: 1

具體問題沒有找到 下面的是個人作法
# rm -rf test/apidoc/* # apidoc -i test/ -o test/apidoc/ -- 這樣子就解決了！

03 :apidoc error: No files found. { Path: ‘/data/wwwroot’ }

應該是由於 nodejs版本過高 以及 npn版本過高的緣由