作為後端開發,我們通常需要維護API文檔,調試API接口,有時需要Mock資料。雖然Postman作為接口調試工具非常好用,但不适合維護API文檔。今天推薦一款功能更強大的工具Apifox,足以滿足我們對API的各種需求,希望對大家有所幫助。
Apifox簡介
Apifox定位為Postman+Swager+Mock+JMeter,具有API文檔管理、API調試、APIMock、API自動化測試等功能。以前使用多種工具的資料同步問題可以通過一種工具來解決。高效、及時、準确!
安裝
Apifox的安裝非常友善,可以直接下載下傳安裝包解壓安裝,下載下傳位址:
http://www.apifox.cn/官方非常貼心地提供了示例項目,直接打開體驗Apifox功能,看界面還是很漂亮的;
如果我們自己使用它,我們首先需要建立一個新的團隊,以促進團隊成員之間的合作。
然後在團隊中建立項目,我們可以在建立成功後開始使用Apifox的強大功能!
API文檔導入
Apifox的API文檔導入功能非常強大,支援Swager、Postman、Yapi、Showdoc等多達20種工具的導入。接下來,我們通過使用mall-tiny-swager項目中的接口來體驗其導入功能!
首先,我們選擇新的接口按鈕和導入;
然後打開導入界面,選擇Swager->URL導入,輸入Swager資料URL;
Apifox将顯示導入預覽,顯示要導入的接口和資料模型,将我們的接口傳回的實體類轉換為資料模型進行重用;
導入成功後,界面效果如下,Apifox區分了檢視文檔和修改文檔,友善我們管理接口文檔。
接口管理
看Apifox的請求參數界面,非常詳細
看Apifox傳回結果界面,支援折疊,這是很多工具沒有的;
看Apifox修改的文檔界面,支援添加狀态、分組和标簽。
接口調試
讓我們體驗一下Apifox的調試功能,比Postman更強大!
當我們開發接口時,我們經常需要分不同的環境。Apifox預設分了測試環境、正式環境和Mock服務。這三個基本上就足夠了;
在調試接口之前,我們必須設定與環境對應的前URL。例如,我們在這裡設定了測試環境;
在Apifox中我們可以使用接口用例來調試我們的接口,接口用例可以儲存我們輸入的參數,以便之後測試使用;
此時,我們輸入錯誤的密碼來調用下接口,斷言将直接提示我們的結果與預期不一緻;
有些接口我們需要傳入Authorization頭才能通路;
我們可以通過環境變量實作這種通路。首先,在登入接口中添加後置操作,選擇提取變量,将傳回的token提取到環境變量AUTH_TOKEN中;
然後修改接口文檔,在Header中設定需要傳入Authorization頭;
接下來在接口用例中通過表達式使用Authorization頭即可正常通路需要登入認證的接口了。
使用腳本
Apifox的自定義前後操作非常強大,不僅支援簡單的斷言和提取變量,還支援編寫JS腳本。
比如我們之前判斷操作成功,斷言code等于200可以用腳本實作;
此時,我們輸入錯誤的密碼來調用下一個接口,斷言将直接表明結果與預期不一緻。
Mock資料
當我們的後端接口沒有開發完成,前端開發需要資料時,通常可以通過Mock提供資料,Apifox的Mock資料功能也非常強大。
Apifox聲稱可以根據您資料模型中的字段名稱智能Mock,讓我們來看看它的規則;
事實上,預設的Mock規則有時并不完善,比如我們來看看它的Mock資料;
此時,我們可以修改資料模型,使Mock資料更加人性化,例如,我們可以将各種狀态設定為枚舉類型;
也可以通過@image将logo字段設定為圖檔類型;
重新設定後,人性化多了;
接下來隻需将環境改為Mock服務即可調用Mock資料接口!
測試管理
Apifox不僅可以支援接口調試,還可以建立批量測試和性能測試的測試用例。
首先,我們可以在測試管理中建立測試用例;
之後選擇從接口用例導入,選擇好需要導入的接口用例;
選擇好運作環境後,點選運作進行批量測試;
測試完成後即可顯示測試報告;
如果你想進行性能測試的話,在測試界面選擇好線程數即可;
測試完成後,可通過導出報告檢視更詳細的報告資訊。
主題設定
個人比較習慣深色主題,Apifox也可以選擇亮色主題和主色的,可以直接在設定中切換。
總結
Apifox确實是一款界面美觀、功能強大的API接口工具。Postman基本具有接口調試功能,還內建了接口文檔管理、資料Mock、自動化測試等功能。強烈建議你試試!