Apidoc生成Restful web Api文件

樣例專案：

一、安裝apidoc模組

apidoc是nodejs模組，github上有安裝和使用說明。

# npm install apidoc -g

eg：引數說明：

-f 檔案過濾

-i **資料夾

-o 輸出api文件的路徑

-t 使用模板檔案的路徑，可以自定義輸出的模板

tips:

引數名稱加[name]，表示可選引數。

四、參考

/**

* @apidefine name 名稱匹配
*//**
* @apidefine pub_params 
* @apiparam  accesskey 授權憑證
* @apiparam  timestamp 時間戳
* @apiparam  random 隨機數
* @apiparam  digest 簽名
*//**
* @api  /bank/api/basicquery.json 根據位址查詢
* @apigroup name
* @apiname 根據位址查詢
* @apiversion 1.0.0
*	 * @apiuse pub_params
* * @apiparam  name 名稱
* @apiparam  [province] 省份
* @apiparam  [city] 城市
* * @apiparamexample  paramexample:
* "* }
*	 * @apisuccess  responsecode 狀態碼：0.成功、-1.非法請求、-2.簽名錯誤、-51.未知錯誤、
* @apisuccess  responsemessage 響應提示資訊
* @apisuccess  bank_type x行
* @apisuccess  city 城市
* @apisuccess  code 號
* @apisuccess  name 名稱
* @apisuccess  province 省份
* * @apisucces***ample   response (success):
* * @apierrorexample error-response:
* */

apidoc文件生成

1 首先要確認你的系統安裝了nodejs，然後執行npm install g apidoc即可。2 配置apidoc，在你的專案下建立apidoc.json檔案，apidoc.json說明 該檔案可以隨便放置，主要執行apidoc i src o apidoc 命令時，是在該檔案目錄下就行，具體下面...

apiDoc 生成api文件

安裝node.js 安裝apidoc npm install apidoc g在你的專案根目錄下新建apidoc.json檔案，該檔案描述了專案對外提供介面的概要資訊如名稱 版本 描述 文件開啟時瀏覽器顯示標題和介面預設訪問位址。apidoc.json apidefine rknotfoundexc...

apidoc生成介面文件

e soft node node global node v v12.18.2 e soft node node global npm v 6.14.5 npm install apidoc g安裝之後進入node的node global目錄如下圖說明安裝完成 增加apidoc.json檔案到專案根...