Apifox(2)快速上手apifox

快速上手

 

使用場景

Apifox 是介面管理、開發、測試全流程集成工具,使用受眾為整個研發技術團隊,主要使用者為前端開發、後端開發和測試人員。

  • 前端開發

    • 介面文檔管理
    • 介面數據 Mock
    • 介面調試
    • 前端程式碼自動生成
  • 後端開發

    • 介面文檔管理
    • 介面調試
    • 介面自動化測試
    • 後端程式碼自動生成
  • 測試人員

    • 介面調試
    • 介面自動化測試
       

最佳實踐

1.前端(或後端)在 Apifox 上定好介面文檔初稿。
2.前後端 一起評審、完善介面文檔,定好介面用例
3.前端 使用系統根據介面文檔自動生成的 Mock 數據進入開發,無需手寫 mock 規則。
4.後端 使用介面用例 調試開發中介面,只要所有介面用例調試通過,介面就開發完成了。如開發過中介面有變化,調試的時候就自動更新了文檔,零成本的保障了介面維護的及時性。
5.後端 每次調試完一個功能就保存為一個介面用例
6.測試人員 直接使用介面用例測試介面。
7.所有介面開發完成後,測試人員(也可以是後端)使用集合測試功能進行多介面集成測試,完整測試整個介面調用流程。
8.前後端 都開發完,前端從Mock 數據切換到正式數據,聯調通常都會非常順利,因為前後端雙方都完全遵守了介面定義的規範。
 

基本概念

介面設計:定義介面規範(如介面路徑、參數、返回值、數據結構等),也就是編寫介面文檔
介面運行:輸入特定的介面參數,然後運行,主要用來調試介面。介面運行完之後點擊保存為用例按鈕,即可生成介面用例,後續可直接運行介面用例,無需再輸入參數,非常方便。
介面用例:通常一個介面會有多種情況用例,比如參數正確用例、參數錯誤用例、數據為空用例、不同數據狀態用例等等。運行介面用例時會自動校驗數據正確性,用介面用例來調試介面非常高效。
數據模型:可復用的數據結構,定義介面返回數據結構請求參數數據結構(僅 JSON 和 XML 模式)時可直接引用。
集合測試:多介面集成測試,主要有功能測試性能測試對比測試
快捷調試:類似 Postman 的介面調試方式,主要用途為臨時調試一些無需文檔化的介面,無需提前定義介面即可快速調試。
程式碼生成:根據介面及數據數據模型定義,系統自動生成介面請求程式碼前端業務程式碼後端業務程式碼
 

與postman設計的區別

和 Postman 不一樣,Apifox 是區分介面設計和介面運行兩個概念的。
介面設計:即 新建介面 介面或介面詳情里的 編輯 介面,用途是 定義介面文檔規範,而不是 運行 介面,所以該介面是只能定義介面基本資訊、參數名及參數說明等,而不能設置參數值參數值前置腳本/後置腳本 等資訊請在介面運行介面或介面用例介面填寫。
介面運行:即介面詳情里的 運行 介面,用途是 臨時調試介面運行完後,需要點擊保存為用例,才能將填寫的 參數值前置腳本/後置腳本 等資訊保存下來;否則關閉 tab 後,這些資訊將會丟失。
 

介面概覽

介面設計介面

介面運行介面

Tags: