Linux使用apidoc自動生成Restful web Api文檔

apidoc簡介

apidoc是一款可以有源代碼中的注釋直接自動生成api接口文檔的工具，它幾乎支援目前主流的所有風格的注釋。

支援的程式設計語言：

1. C#, Go, Dart, Java, JavaScript, PHP(all DocStyle capable languages)
2. CoffeeScript
3. Erlang
4. Ruby

安裝node環境(已安裝可忽略)

1. 官網下載下傳已編譯好的安裝包

以Centos7.4 64位為例, 下載下傳位址: https://nodejs.org/dist/v12.18.3/node-v12.18.3-linux-x64.tar.xz

wget https://nodejs.org/dist/v12.18.3/node-v12.18.3-linux-x64.tar.xz
#或者下載下傳到本地上傳
           

2.執行解xz、解壓指令

​xz -d node-v12.18.3-linux-x64.tar.xz
tar -xvf node-v12.18.3-linux-x64.tar​
           

3.建立軟連接配接

ln -s ~/node-v12.18.3-linux-x64/bin/node /usr/bin/node
​ln -s ~/node-v12.18.3-linux-x64/bin/npm /usr/bin/npm
           

ln指令用于建立軟連接配接（類似與Windows的快捷方式）必須給全路徑，否則可能關聯錯誤

4.測試

node -v
npm
           

安裝apidoc

npm install apidoc -g
           

測試apidoc是否安裝成功

解決方法：

cd到apidoc，將bin目錄下的apidoc指令，軟連接配接到/usr/local/bin

cd ~/node-v12.18.3-linux-x64/lib/node_modules/apidoc/bin/apidoc
ln -s ~/node-v12.18.3-linux-x64/lib/node_modules/apidoc/bin/apidoc /usr/local/bin
           

最後到對應項目下運作apidoc指令即可生成文檔

apidoc -i 接口路徑 -o 生成文檔路徑
           

apidoc具體使用

參考官方文檔https://apidocjs.com/