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