快速上手
使用場景
Apifox 是接口管理、開發、測試全流程集成工具,使用受眾為整個研發技術團隊,主要使用者為前端開發、后端開發和測試人員。
-
前端開發
- 接口文檔管理
- 接口數據 Mock
- 接口調試
- 前端代碼自動生成
-
后端開發
- 接口文檔管理
- 接口調試
- 接口自動化測試
- 后端代碼自動生成
-
測試人員
- 接口調試
- 接口自動化測試
最佳實踐
1.前端(或后端)在 Apifox 上定好接口文檔初稿。
2.前后端 一起評審、完善接口文檔,定好接口用例。
3.前端 使用系統根據接口文檔自動生成的 Mock 數據進入開發,無需手寫 mock 規則。
4.后端 使用接口用例 調試開發中接口,只要所有接口用例調試通過,接口就開發完成了。如開發過中接口有變化,調試的時候就自動更新了文檔,零成本的保障了接口維護的及時性。
5.后端 每次調試完一個功能就保存為一個接口用例。
6.測試人員 直接使用接口用例測試接口。
7.所有接口開發完成后,測試人員(也可以是后端)使用集合測試功能進行多接口集成測試,完整測試整個接口調用流程。
8.前后端 都開發完,前端從Mock 數據切換到正式數據,聯調通常都會非常順利,因為前后端雙方都完全遵守了接口定義的規范。
基本概念
接口設計:定義接口規范(如接口路徑、參數、返回值、數據結構等),也就是編寫接口文檔。
接口運行:輸入特定的接口參數,然后運行,主要用來調試接口。接口運行完之后點擊保存為用例按鈕,即可生成接口用例,后續可直接運行接口用例,無需再輸入參數,非常方便。
接口用例:通常一個接口會有多種情況用例,比如參數正確用例、參數錯誤用例、數據為空用例、不同數據狀態用例等等。運行接口用例時會自動校驗數據正確性,用接口用例來調試接口非常高效。
數據模型:可復用的數據結構,定義接口返回數據結構及請求參數數據結構(僅 JSON 和 XML 模式)時可直接引用。
集合測試:多接口集成測試,主要有功能測試、性能測試、對比測試。
快捷調試:類似 Postman 的接口調試方式,主要用途為臨時調試一些無需文檔化的接口,無需提前定義接口即可快速調試。
代碼生成:根據接口及數據數據模型定義,系統自動生成接口請求代碼、前端業務代碼及后端業務代碼。
與postman設計的區別
和 Postman 不一樣,Apifox 是區分接口設計和接口運行兩個概念的。
接口設計:即 新建接口 界面或接口詳情里的 編輯 界面,用途是 定義接口文檔規范,而不是 運行 接口,所以該界面是只能定義接口基本信息、參數名及參數說明等,而不能設置參數值。參數值、前置腳本/后置腳本 等信息請在接口運行界面或接口用例界面填寫。
接口運行:即接口詳情里的 運行 界面,用途是 臨時調試接口,運行完后,需要點擊保存為用例,才能將填寫的 參數值、前置腳本/后置腳本 等信息保存下來;否則關閉 tab 后,這些信息將會丟失。
界面概覽
接口設計界面

接口運行界面

