有關Apifox軟體之前寫過一篇文章: 介面測試神器Apifox,親測好用!
如何一鍵自動生成資料庫文件
之前也寫過一篇文章: 資料庫界的Swagger:一鍵生成資料庫文件!
一、Apifox外掛的優勢
作為一名後端開發在專案開發過程中,肯定需要提供介面文件。
一般我們有兩種方案
- 專案結合
Swagger
,自動生成介面文件。 - 手動將介面複製到其它介面文件,比如postman、Apifox。
第一種方案缺陷在於
- 為了生成完整介面文件,我們會程式碼入侵且增加開發工作量
- 當我們只需提供幾個介面給第三方,總不能直接提供Swagger所有介面文件吧
第二種方案缺陷在於
- 需要一個一個將介面寫在對應的介面文件上,耗費大量時間
- 當介面發生變更了,還需要修改下介面文件,會經常出現只修改介面忘記去修改介面文件的情況。
這時候這款外掛神器就來了,它不僅可以解決上面的缺陷,而且還有更強大的功能,它可以支援直接在IDEA上做介面聯調測試!
二、Apifox外掛簡單介紹
該外掛主要用於 IDEA 專案快速生成 API 文件,並同步到 Apifox,程式碼零入侵
。
- 基於 javadoc(Java)、KDoc(Kotlin)、ScalaDoc(Scala) 解析API文件。
- 支援 Swagger 註解
注意
:可以在保持程式碼零侵入的情況下得到相當完整的 API 文件,但是特殊的需求還是需要部分特殊的註釋/註解配合
功能特性
- 匯出 API 文件到 Apifox
- 匯出 Markdown 格式 API 文件
- 在 IDEA 中直接發起 API 請求
三、IDEA安裝外掛
1、支援以下IDEA
- IntelliJ IDEA 193.+(2019.3+)
- IntelliJ IDEA Community Edition 174+(2017.4+)
2、搜尋安裝
- 開啟IDEA > Preferences(Settings) > Plugins ,搜尋
Apifox Helper
安裝完成後,你就可以使用上面說的功能特性了。
如果是同步到 Apifox 專案,你還需要下載或註冊 Apifox 軟體
,建立一個對應的專案(這個具體操作看上面那篇文章就可以了)
四、 將IDEA專案和Apifox的專案關聯
1、基礎配置
安裝外掛後,進入設定介面 Preferences(Settings) > ApifoxUploader
1、 Apifox 伺服器地址: 填寫 Apifox API 服務地址,SaaS 版預設為 https://api.apifox.cn
2、 Apifox 個人訪問令牌:就是你既然要同步到你的Apifox客戶端
,肯定需要在客戶端拿到一個令牌
3、模組專案 ID 配置: 就是你要讓IDEA知道 你要同步到Apifox客戶端下面的哪個具體專案
下
2、個人訪問令牌獲取
在 Apifox軟體中 點選個人頭像處的 賬號設定
中選擇 API 訪問令牌
,新建令牌後複製生成的 Token 就是令牌。
3、模組專案 ID 配置
在 Apifox 中對應專案的 專案設定
中選擇 基本設定
,複製專案ID
,填寫在以上的對應位置處。
到目前為止,所有的準備設定工作都已經做好了,可以實現文件的自動生成和更新同步了。
五、自動生成介面文件測試
1.開啟需要上傳的 Controller 檔案,右鍵選擇 Upload to Apifox
。
2.去 Apifox 專案內,就可以看到剛才自動同步過來的文件了(如果你已經在當前專案了需要點選一下重新整理)。
3.當後續介面程式碼有變動或更新時,再次點選 Upload to Apifox
就可以同步。
六、直接在 IDEA 裡除錯
Apifox外掛還有一個非常牛逼的功能就是支援在 IDEA 中一鍵發起介面自測,不需要切換其他軟體。
在 IDEA 中選中需要除錯的 API 檔案,右鍵選擇 Call API
發起請求就可以。
之後就可以在IDEA直接除錯介面了,是不是非常方便!
還有許多細節的功能可以看他們的幫助文件,寫的也非常的詳細!
Apifox官方使用文件: https://www.apifox.cn/help/