在自定生成api文件方面以前都是使用swagger.json結合swagger工具來生成文件，偶然發現了apidoc這個生成api的工具，發現使用起來比swagger更加簡單，下面整理一下使用過程：
首先通過npm全域性安裝apidoc
$ npm install apidoc -g
使用的時候最主要是參考官方文件 ，apidoc文件，文件中清晰的記錄了怎麼使用的過程，最好也要看一下apidoc的github位址，從**你可以看到乙個簡單的example，
下面就是利用github上apidoc的example來作為例項，example的結構如下：
weifandemacbook-pro:example weifan$ ls_apidoc.js apidoc.json example.js footer.md header.md
首先我們在執行apidoc命令的目錄下，新建乙個apidocs檔案，命令如下：
mkdir apidocs
然後執行生成api文件命令，如下：
$ apidoc -i example/ -o apidocs/
其中apidoc 引數如下：
在你執行上面命令的時候如果example資料夾下沒有apidoc.json這個檔案，則會出現一下警告資訊：
warn: please create an apidoc.json configuration file.info: done.
說明你沒有配置生成api的配置檔案（如果沒有其實也是可以生成的只不過是預設格式）。
此時你會看到apidocs資料夾下回有生成的index.html檔案，在瀏覽器中執行這個檔案，你就會看到你生成的api文件了。
在執行apidoc命令的目錄執行建立apidoc.json檔案，並加入以下內容：
,"footer": ,
"template":
}
template
下面是apidoc的註解，最主要還是要參照官方文件。
無法生成帶有歷史版本比較功能
必須同時加上@apiversion@apiname@apigroup這個三個註解
@apiname後面不要使用中文介紹，必須要使用英文，不然這個api可能會被隱藏。詳見：
最好不要包含一些特殊字元，特殊字元可能會導致編譯有問題
官方文件:
官方示例:
ApiDoc 自動生成API文件
1 確認已經安裝node.js 可以使用npm命令 否則要先安裝node 2 安裝apidoc 命令列執行 npminstall apidoc g 3 在專案的當前目錄下編寫乙個指令碼genapidoc.bat 內容為 apidoc o doc apidoc pause 將生成的api文件 o 輸出...
apiDoc 生成api文件
安裝node.js 安裝apidoc npm install apidoc g在你的專案根目錄下新建apidoc.json檔案，該檔案描述了專案對外提供介面的概要資訊如名稱 版本 描述 文件開啟時瀏覽器顯示標題和介面預設訪問位址。apidoc.json apidefine rknotfoundexc...
自動生成apidoc介面文件
開發過程中，個人認為編寫介面文件是個很煩人的事，沒有或者隨便寫，前端對接的時候不清楚就更煩人了。使用aoidoc可以簡化這個操作，可我有時候連apidoc的注釋都懶得寫 api management smhard insert 新增 apiname insert apigroup 智慧型裝置 api...