推薦一款技術人必備的接口測試神器:Apifox
1. 背景
作為互聯網行業技術從業者,接口調試是必不可少的一項技能,通常我們都會選擇使用 Postman 這類工具來進行接口調試,在接口調試方面 Postman 做的確實非常出色。當然除了Postman,還有它的老婆: Postwoman
也同樣很出色,公號之前有發表過一篇關於它老婆Postwoman
使用的文章,詳細可閱:推薦一款 Postman 的開源替代品: Postwoman
但是在整個軟件開發過程中,接口調試只是其中的一部分,還有很多事情 Postman 是無法完成的,或者無法高效完成,比如:接口文檔定義、Mock 數據、接口自動化測試等等。
今天給大家推薦的一款神器: Apifox,它是集:接口文檔管理
、接口調試
、Mock
、接口自動化測試
於一體的。有的讀者咋一看,會覺得和YAPI
有點類似,但兩者在功能特色上,只能說是各有千秋的。
細心的讀者,會發現文章,正文乾貨還沒有開始,就已經為大家推薦了三款效率神器: Apifox、Postwoman、YAPI。
2. 聊一聊接口管理的現狀
對於接口管理的現狀來說,目前行業大部分採取的解決方案有如下幾種:
-
使用 Swagger 管理接口文檔。
-
使用 Postman 調試接口。
-
使用 RAP或Easy Mock來進行 Mock 數據。
-
使用 JMeter 做接口自動化測試。
上述的接口管理手段,咋一看,貌似沒有什麼問題,但仔細分析,不難發現,當中存在的問題還真不少,比如要維護不同工具,並且這些工具之間數據一致性非常困難、非常低效。這裡不僅僅是工作量的問題,更大的問題是多個系統之間數據不一致,導致協作低效,頻繁出問題,開發人員、測試人員痛苦不堪。
設想一下這樣的一個協作流程:
- 開發人員在 Swagger 定義好文檔後,接口調試的時候還需要去 Postman 再定義一遍。
- 前端開發 Mock 數據的時候又要去 RAP 或Easy Mock定義一遍,手動設置好 Mock 規則。
- 測試人員需要去 JMeter 定義一遍。
- 前端根據 RAP 或Easy Mock定義 Mock 出來的數據開發完,後端根據 Swagger 定義的接口文檔開發完,各自測試測試通過了,本以為可以馬上上線,結果一對接發現各種問題:原來開發過程中接口變更,只修改了 Swagger,但是沒有及時同步修改 RAP 或Easy Mock。
- 同樣,測試在 JMeter 寫好的測試用例,真正運行的時候也會發現各種不一致。
- 時間久了,各種不一致會越來越嚴重。
3. Apifor介紹
官方對Apifor定位,Apifox = Postman + Swagger + Mock + JMeter,如下圖所示
Apifox
目標是通過一套系統、一份數據,解決多個系統之間的數據同步問題。只要定義好接口文檔,接口調試、數據 Mock、接口測試就可以直接使用,無需再次定義;接口文檔和接口開發調試使用同一個工具,接口調試完成後即可保證和接口文檔定義完全一致。高效、及時、準確!
官方地址://www.apifox.cn/#
概括來講,Apifox常用 功能分為四類功能:
- 接口文檔定義功能:Apifox 遵循 OpenApi 3.0 (原Swagger)、JSON Schema 規範的同時,提供了非常好用的可視化文檔管理功能,零學習成本,非常高效。
- 接口調試功能:Postman 有的功能,比如環境變量、預執行腳本、後執行腳本、Cookie/Session 全局共享 等功能,Apifox 都有,並且和 Postman 一樣高效好用。
- 數據 Mock功能:內置 Mock.js 規則引擎,非常方便 mock 出各種數據,並且可以在定義數據結構的同時寫好 mock 規則。支持添加「期望」,根據請求參數返回不同 mock 數據。最重要的是 Apifox
零配置
即可 Mock 出非常人性化的數據,具體在本文後面介紹。 - 接口自動化測試:提供接口集合測試,可以通過選擇接口(或接口用例)快速創建測試集。目前接口自動化測試更多功能還在開發中!目標是: JMeter 有的功能基本都會有,並且要更好用。
4. Apifor小試牛刀
接下來,帶着大家,來體驗一下Apifor的使用。
1、先在官網下載對應系統安裝包,進行安裝,安裝完成後,第一次啟動需要先登錄。
Ps: 登錄前,需要先通過郵箱來註冊一個帳號。
2、 登錄成功後,Apifox默認給了一些例子,如果看它的界面會發現和Postman界面比較相似。
Ps: 當然也不要被它的外表所欺騙了,還是有別於Postman的。
3、在本地啟一個API服務,端口為8000, 在Apifor上,新建一個新的測試環境,如下所示:
4、新建一分類:接口測試
,或直接在默認分類上,新建一條接口用例,如下所示
如上圖,添加對應的基礎信息、配置請求參數等。
5、選擇測試環境,點擊發送
按鈕,運行接口測試用例。
看到這裡,可能有些讀者覺得和Postman功能基本是一樣的,不妨接着往下看。
5. Apifor更多特性
1、調試時自動校驗數據結構
使用 Apifox 調試接口的時候,系統會根據接口文檔里的定義,自動校驗返回的數據結構是否正確,無需通過肉識別,也無需手動寫斷言腳本檢測,非常高效!
根據官方的示例可以看出,在運行集合測試時,可以結合自動校驗數據結構的功能, 清晰展示出失敗用例校驗不通過的原因。
2、零配置 Mock 出非常人性化的數據
1、 為上述示例,添加一個mock測試服務,配置如下所示:
按照接口字段數據格式要求,根據mock.js語法,配置保存完畢,運行後,自動生成一個mock服務。
其中,Mock.js語法示例可見://mockjs.com/examples.html
可以看出 Apifox 零配置
Mock 出來的數據和真實情況是非常接近的,前端開發可以直接使用,而無需再手動寫mock規則。
3、代碼自動生成
根據接口模型定義,自動生成各種語言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的業務代碼(如 Model、Controller、單元測試代碼等)和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動生成。
更重要的是:你可以通過自定義代碼模板
來生成符合自己團隊的架構規範的代碼,滿足各種個性化的需求。
4、導入、導出
- 支持導出
OpenApi (原Swagger)
、Markdown
、Html
等數據格式,因為可以導出OpenApi
格式數據,所以你可以利用 OpenApi (Swagger) 豐富的生態工具完成各種接口相關的事情。 - 支持導入
OpenApi (原Swagger)
、Postman
、HAR
、RAP2
、yapi
、Eolinker
、DOClever
、ApiPost
、Apizza
等數據格,方便遷移舊項目。
6. 小結
雖然Apifox目前有些功能還並不完善,但整的來說,Apifox還是不錯的,也為接口開發調試測試提供了一種效率更佳的的解決方案,按照Apifox開發團隊後續規劃,後續會重加增加接口性能測試能力支持(類似JMeter)、支持離線團隊多人協作等特性。