去年,在公眾號給大家推薦了一款新面市不久的接口測試神器:Apifox,如果還未了解的讀者,感興趣的話可查閱原文:推薦一款技術人必備的接口測試神器:Apifox
為了照顧新進來的讀者,且最近一年,Apifox官方又發布了一些新特性,趁此機會,再給大家分享一波。
簡單來說,Apifox它是集:接口文檔管理
、接口調試
、Mock
、接口自動化測試
於一體的全流程集成工具,覆蓋從開發->測試->管理
等環節,等同於 Postman + Swagger + Mock + JMeter
幾款工具功能累加。
利用Apifox可以實現:
-
通過Apifox可實現一套系統、一份數據,解決多個系統之間的數據同步問題。
-
只要定義好接口文檔,接口調試、數據 Mock、接口測試就可以直接使用,無需再次定義;
-
接口文檔和接口開發調試使用同一個工具,接口調試完成后即可保證和接口文檔定義完全一致。
文末可免費領取apifox學習資料(PPT、PDF版)!
1. 從接口管理現狀聊起
在提及Apifox之前,需要先從接口管理現狀聊起,對於接口管理的現狀來說,目前行業大部分采取的解決方案有如下幾種:
- 使用 Swagger 管理接口文檔。
- 使用 Postman 調試接口。
- 使用 RAP或Easy Mock來進行 Mock 數據。
- 使用 JMeter 做接口自動化測試。
- 現有方案面臨的問題
維護不同工具之間數據一致性非常困難、低效。並且這里不僅僅是工作量的問題,更大的問題是多個系統之間數據不一致,導致協作低效、頻繁出問題,開發測試人員痛苦不堪。
- 開發人員在 Swagger 定義好文檔后,接口調試的時候還需要去 Postman 再定義一遍。
- 前端開發 Mock 數據的時候又要去 RAP 定義一遍,還需要手動設置 Mock 規則。
- 測試人員需要去 JMeter 再定義一遍。
- 前端根據 RAP Mock 出來的數據開發完,后端根據 Swagger 定義的接口文檔開發完,各都試測試通過了,本以為可以馬上上線,結果一對接發現各種問題:
- 開發過程中接口變更了,只修改了 Swagger,但是沒有及時同步修改 RAP。
- 后端開發的接口數據類型和文檔不一致,肉眼難以發現問題。
- 同樣,測試在 JMeter 寫好的測試用例,真正運行的時候也會發現各種不一致。
- 時間久了,各種不一致會越來越嚴重。
3. Apifox 如何解決這些問題
在前面提到了Apifox = Postman + Swagger + Mock + JMeter
它是通過一套系統、一份數據,解決多個系統之間的數據同步問題。只要定義好接口文檔,接口調試、數據 Mock、接口測試就可以直接使用,無需再次定義;接口文檔和接口開發調試使用同一個工具,接口調試完成后即可保證和接口文檔定義完全一致。高效、及時、准確!
當然如果你認為 Apifox 只做了數據打通,來提升研發團隊的效率,那就錯了。Apifox 還做了非常多的創新,來提升開發人員的效率。
4、Apifox 功能
1、接口支持“用例管理”
通常一個接口會有多種情況用例,比如 正確用例
參數錯誤用例
數據為空用例
不同數據狀態用例
。定義接口的時候定義好這些不同狀態的用例,接口調試的時候直接運行,非常高效。
2、“數據模型”定義、引用
可以獨立定義數據模型,接口定義時可以直接引用數據模型,數據模型之間也可以相互引用。同樣的數據結構,只需要定義一次即可多處使用;修改的時候只需要修改一處,多處實時更新,避免不一致。
3、調試時“自動校驗”數據結構
使用 Apifox 調試接口的時候,系統會根據接口文檔里的定義,自動校驗返回的數據結構是否正確,無需通過肉識別,也無需手動寫斷言腳本檢測,非常高效!
4、“可視化”設置斷言
設置斷言:
運行后,查看斷言結果:
5、“可視化”設置提取變量
6、支持數據庫操作
7、“零配置”Mock 出非常人性化的數據
先放一張圖對比下 Apifox 和其他同類工具 零配置
mock 出來的數據效果:
可以看出 Apifox 零配置
Mock 出來的數據和真實情況是非常接近的,前端開發可以直接使用,而無需再手動寫 mock 規則。
Apifox 如何做到高效率
、零配置
生成非常人性化的 mock 數據
- Apifox 根據接口定義里的數據結構、數據類型,自動生成 mock 規則。
- Apifox 內置智能 mock 規則庫,根據字段名、字段數據類型,智能優化自動生成的 mock 規則。如:名稱包含字符串
image
的string
類型字段,自動 mock 出一個圖片地址 URL;包含字符串time
的string
類型字段,自動 mock 出一個時間字符串;包含字符串city
的string
類型字段,自動 mock 出一個城市名。 - Apifox 根據內置規則,可自動識別出圖片、頭像、用戶名、手機號、網址、日期、時間、時間戳、郵箱、省份、城市、地址、IP 等字段,從而 Mock 出非常人性化的數據。
- 除了內置 mock 規則,用戶還可以自定義規則庫,滿足各種個性化需求。支持使用
正則表達式
、通配符
來匹配字段名自定義 mock 規則。
8、代碼自動生成
根據接口模型定義,自動生成各種語言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的業務代碼(如 Model、Controller、單元測試代碼等)和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動生成。
更重要的是:你可以通過自定義代碼模板
來生成符合自己團隊的架構規范的代碼,滿足各種個性化的需求。
9、導入、導出
-
支持導出
OpenApi (Swagger)
、Markdown
、Html
等數據格式,因為可以導出OpenApi
格式數據,所以你可以利用 OpenApi (Swagger) 豐富的生態工具完成各種接口相關的事情。 -
支持導入
OpenApi (Swagger)
、Postman
、HAR
、RAML
、RAP2
、YApi
、Eolinker
、NEI
、DOClever
、ApiPost
、Apizza
、ShowDoc
、API Blueprint
、I/O Docs
、WADL
、Google Discovery
等數據格式,方便舊項目遷移。 -
5、 Apifox 后續規划
官方后續功能規划:
- 接口性能測試支持(類似 JMeter)。
- 支持插件市場,可以自己開發插件。
- 支持更多接口協議,如
GraphQL
、websocket
等。 - 支持離線使用,項目可選擇在線同步(團隊協作)還是僅本地存儲(單機離線使用)。
需要嘗鮮的,可訪問 Apifox 官網下載:https://www.apifox.cn/
想進一步了解 學習Apifox 的,關注公眾號回復:【apifox】即可免費獲取PPT 版本的學習資料(適用於團隊內部分享Apifox)。