Springboot中使用apidoc生成介面文件

當前後端分離時，需要前後端共同定義介面，編寫介面文件。所以，在專案開發過程中需要有乙個統一的檔案進行溝通交流開發。

對開發人員而言，專案的維護和人員更迭，都需要文件來作為記錄。方便後期人員檢視、維護。

確認當前電腦安裝了node.js。檢測是否安裝

node -h

出現提示，表明已經安裝node.js。如果沒有，需要安裝node.js

安裝apidoc

npm install apidoc -g

然後再測試一下apidoc是否安裝成功

apidoc -h

首先準備乙個空的springboot的專案。

位置如下圖所示：

package.json 檔案內容：

/**
* @api /index/:username
* @apidescription 這只是乙個測試的介面描述
* @apiname index
* @apiparam username 使用者的姓名
* @apiparam userage 使用者的年齡
* @apiparamexample request-example:
* * @apigroup index
* @apierror usernotfound theid
* @apisamplerequest /index
*/@responsebody
@crossorigin
public string index(@requestparam("username") string username, @requestparam("userage") int userage)

很簡單，直接在方法上面加入注釋，在注釋中使用官方的一些註解來解釋方法的屬性。

apidoc 和 swagger不同的是，介面文件和**檔案都是分開的。一開始只需要專心編寫介面**，當**編寫完成時，只需在方法上加上指定的注釋。（到這裡，也就是我上述所描述的內容）。最終通過一段命令執行生成最終的html文件。

回歸正題，在準備工作中我們已經安裝了apidoc，然後我們通過apidoc命令生成文件：

apidoc -i apitestdemo/ -o apidocdemo/

結果：

-i 指定原始檔的目錄，也就是專案的根目錄。

-o 指定輸出文件的目錄，生成文件的位址。

頁面展示：

開啟index 頁面：

ok，到這裡再對照前面的package.json 中的內容看，就已經很明了了。

apidoc 不是內部或外部命令，也不是可執行程式。

解決方案：這種問題首先排除沒有安裝apidoc的可能性，如果安裝了apidoc，也就是在當前目錄下不能使用apidoc這個命令，那麼我們改在什麼目錄下使用呢，其實在安裝apidoc 我們注意一下輸出內容：

將cmd切換到對應的目錄下（我的是 d:\nodejs\npminstall），在當前目錄下執行apidoc 就可以了。

Springboot中使用apidoc生成介面文件

Spring Boot中使用MongoDB資料庫

Spring Boot中使用MongoDB資料庫

SpringBoot中使用日誌

Springboot中使用apidoc生成介面文件

Spring Boot中使用MongoDB資料庫

Spring Boot中使用MongoDB資料庫

SpringBoot中使用日誌

相關推薦