Apifox 是接口管理、開發、測試全流程集成工具,定位 Postman + Swagger + Mock + JMeter
。只要定義好接口文檔,接口調試、數據 Mock、接口測試就可以直接使用,無需再次定義。
1、開發測試過程中的現狀
yapi -- 管理接口文檔
rap -- 前端開發mock數據
postman -- 開發調試接口、測試調用接口
2、存在的問題和痛點
-
接口文檔和實際開發的接口數據類型可能存在不一致,導致前后端未達成統一,測試時遇到問題,耗費時間;
-
一個接口,至少被定義四次:服務端開發調試時、前端開發mock時、接口測試時、jmeter壓測時,在需求量大,開發、測試時間緊迫時,重復定義接口,顯得有些浪費資源;
-
測試中有時需要通過更改數據庫數據,再調用接口,來進行測試,頻繁操作時,比較麻煩;
3、用apifox可以解決的問題
-
提高開發接口數據類型的規范型,前后端雙方都完全遵守接口定義的規范,使得聯調更加順利;
-
提高服務端冒煙通過率,開發定義好接口並調通后,可以立即保存為一個測試用例,測試可以在提測前根據這個模板提前編寫接口測試用例給開發自測;
-
數據共享,只需開發定義一次接口,即可實現多種操作,減少他人因為配置錯誤等問題導致的接口調試失敗幾率,從而節省一定的時間;
-
連接數據庫,快速准備需要的測試數據;
二、安裝
下載安裝包后,一鍵安裝即可。下載鏈接:https://www.apifox.cn/
三、使用
1、使用場景
后端開發
-
接口文檔管理
-
后端代碼自動生成
-
接口調試
-
接口自測
前端開發
-
接口文檔管理
-
接口數據 Mock
-
接口調試
-
前端代碼自動生成
測試人員
-
接口調試
-
接口測試
-
性能測試
2、基本功能
1)團隊協作
接口數據雲端同步,實時更新;支持團隊/項目管理員、普通成員、只讀成員等權限管理
-
安裝后,登錄自己的賬號,由團隊成員邀請加入,通過后,即可共享團隊所有項目的接口數據
2)導入導出
導入接口文檔
以YApi舉例
-
從yapi平台,選擇服務-數據管理,導出json格式的文件
-
apifox - 接口管理 - 導入,選擇數據格式為YApi,導入json文件
-
導入成功后,點擊接口管理,即可看到導入的接口數據
導入抓包數據
3)接口&用例
定義接口的請求信息、基礎狀態信息、response示例信息
通過前置、后置操作,對數據進行處理和斷言;
自動校驗接口中定義的response數據結構,也可自定義response校驗點
測試用例集
測試用例主要用來做接口集合測試,每個用例包含多個測試步驟,每個步驟都是一個接口請求
查看測試報告
可以查看歷史的執行記錄,目前測試報告數據僅存放在本地電腦
基本的性能測試
執行用例時,可設置循環次數、線程數,可導入批量的測試數據
4)快速mock
根據接口定義的數據結構自動生成測試數據,無需配置mock規則,方便前端調試
5)變量的管理及使用
公共數據可配置遠程值:“遠程值”會同步保存到服務器,僅用於成員之間相互同步,實際運行時都是讀寫“本地值”
自己的測試數據可配置本地值:“本地值”僅保存在本地,不會同步到服務器,團隊成員之間也不會相互同步
外部使用變量:{{變量名}
腳本中獲取/設置變量:通過get/set
6)數據庫連接
項目設置 - 數據庫連接,可管理連接的數據庫
數據庫連接信息僅存儲在本地,不會同步到雲端,所以使用時,需自己手動設置
7)自定義腳本
apifox支持多種語言腳本:java、python、PHP、js等
舉個栗子
自定義python腳本,獲取外部的傳參
在指定目錄下,放入自己的腳本
apifox調用腳本、傳參
參考文檔:https://www.apifox.cn/help/