有關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/
轉載請註明出處,本文鏈接:https://www.uj5u.com/houduan/545191.html
標籤:其他
上一篇:LeetCode演算法訓練 93.復原IP地址 78.子集 90.子集II
下一篇:JVM總結
