ApiDoc 自動生成API文件

2021-08-13 14:56:50 字數 398 閱讀 7717

1、確認已經安裝node.js

可以使用npm命令

否則要先安裝node

2、安裝apidoc

命令列執行

npminstall

apidoc -g 3、

在專案的當前目錄下編寫乙個指令碼genapidoc.bat

內容為

apidoc -o ../doc/apidoc/

pause

(將生成的api文件 -o 輸出output到上層資料夾的doc/apidoc下)

4、配置(apidoc.json)

5、配置完成之後,在命令列下進入專案目錄,執行指令碼檔案genapidoc.bat

即可在doc/apidoc下自動生成api文件

開啟index.html

apiDoc自動生成api文件

在自定生成api文件方面以前都是使用swagger.json結合swagger工具來生成文件,偶然發現了apidoc這個生成api的工具,發現使用起來比swagger更加簡單,下面整理一下使用過程 首先通過npm全域性安裝apidoc npm install apidoc g 使用的時候最主要是參考...

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...