1、首先要確認你的系統安裝了nodejs
,然後執行npm install -g apidoc
即可。
2 、配置apidoc
,在你的專案下建立apidoc.json
檔案,apidoc.json說明(該檔案可以隨便放置,主要執行apidoc -i src/ -o apidoc/ 命令時,是在該檔案目錄下就行,具體下面會詳細解釋);
apidoc.json 內容如下:
執行命令apidoc -i src/ -o apidoc/ (此命令需在剛才建立的json檔案目錄下執行)
此文主要是用於個人學習筆記,感謝 小菜荔枝 參考鏈結
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檔案到專案根...
ApiDoc 自動生成API文件
1 確認已經安裝node.js 可以使用npm命令 否則要先安裝node 2 安裝apidoc 命令列執行 npminstall apidoc g 3 在專案的當前目錄下編寫乙個指令碼genapidoc.bat 內容為 apidoc o doc apidoc pause 將生成的api文件 o 輸出...