API 設計人員使用 Swagger 寫 API 文檔

前端開發 使用 mock.js ?mock 假的 API 數據

后端開發 使用 Postman 調試 API

測試人員 使用 JMeter 測試 API

我們團隊是前后端同步進入開發的，不能等后端開發完了才出接口文檔，前端再進入開發，所以使用后端代碼注釋自動生成 Swagger 不適合我們。

寫 Swagger 文檔效率很低，并且有學習門檻，讓團隊所有人都熟練手寫 Swagger 文檔是不現實的，更何況團隊不停有新人進來。

開發人員在 Swagger 定義好文檔后，接口調試的時候還需要去 Postman 再定義一遍。

前端開發 Mock 數據的時候又要去 mock 工具里定義一遍，手動設置好 Mock 規則。

測試人員需要去 JMeter 定義一遍。

前端根據 mock 工具出來的數據開發完，后端根據 Swagger 定義的接口文檔開發完，各自測試測試通過了，本以為可以馬上上線，結果一對接發現各種問題：原來開發過程中接口變更，只修改了 Swagger，但是沒有及時同步修改 mock。

同樣，測試在 JMeter 寫好的測試用例，真正運行的時候也會發現各種不一致。

開發過程，經常會有發現開始定義的接口文檔有不合理的地方，需要臨時調整，經常出現接口改了，但是文檔沒有更新。

時間久了，各種不一致會越來越嚴重。

降低寫文檔的成本

增加寫文檔后的收益

以完全可視化的界面來編寫文檔，并且是零學習成本，新人 一來就能上手。

可以通過接口文檔定義的數據結構自動 mock出數據，而無需 前端開發 再寫mock規則，直接開工。

后端開發 在接口文檔基礎上調試接口，而無需在去Postman上調試；接口如有變化，調試的時候就自動更新了文檔，零成本的保障了接口維護的及時性；自動根據文檔校驗數據結構，無需肉眼校驗，無需手動寫斷言。

后端開發 每次調試完一個功能就保存為一個接口用例。

測試人員 直接使用接口用例測試接口。

測試人員 更加接口文檔自動生成測試用例，然后像JMeter一樣在直接在上面測試。

根據接口文檔定義的數據結構，自動生成前后端的數據模型代碼。

前端（或后端）在 Apifox 上定好接口文檔初稿。

前后端 一起評審、完善接口文檔，定好接口用例。

前端 使用 Apifox 自動生成的 Mock 數據進入開發，而無需手寫mock規則，直接開工。

后端 使用接口用例 調試開發中接口，系統根據接口文檔的定義自動校驗返回的數據是否正確，只要所有接口用例調試通過，接口就開發完成了。

后端 開發完成后，測試人員（也可以是后端）使用集合測試功能進行多接口集成測試，完整測試整個接口調用流程。

前后端 都開發完，前端從Mock 數據切換到正式數據，聯調通常都會非常順利，因為前后端雙方都完全遵守了接口定義的規范。

接口設計：Apifox 接口文檔遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 規范的同時，提供了非常好用的可視化文檔管理功能，零學習成本，非常高效。并且支持在線分享接口文檔。

數據模型：可復用的數據結構，定義接口返回數據結構及請求參數數據結構（僅 JSON 和 XML 模式）時可直接引用。支持模型直接嵌套引用，直接 JSON/XML 智能導入，支持 oneOf、allOf 等高級組合模式。

接口調試：Postman 有的功能，比如環境變量、前置/后置腳本、Cookie/Session 全局共享 等功能，Apifox 都有，并且比 Postman 更高效好用。接口運行完之后點擊保存為用例按鈕，即可生成接口用例，后續可直接運行接口用例，無需再輸入參數，非常方便。自定義腳本 100% 兼容 Postman 語法，并且支持運行javascript、java、python、php、js、BeanShell、go、shell、ruby、lua等各種語言代碼。

接口用例：通常一個接口會有多種情況用例，比如參數正確用例、參數錯誤用例、數據為空用例、不同數據狀態用例等等。運行接口用例時會自動校驗數據正確性，用接口用例來調試接口非常高效。

接口數據 Mock：內置 Mock.js 規則引擎，非常方便 mock 出各種數據，并且可以在定義數據結構的同時寫好 mock 規則。支持添加“期望”，根據請求參數返回不同 mock 數據。最重要的是 Apifox 零配置 即可 Mock 出非常人性化的數據，具體在本文后面介紹。

數據庫操作：支持讀取數據庫數據，作為接口請求參數使用。支持讀取數據庫數據，用來校驗(斷言)接口請求是否成功。

接口自動化測試：提供接口集合測試，可以通過選擇接口（或接口用例）快速創建測試集。目前接口自動化測試更多功能還在開發中，敬請期待！目標是：JMeter 有的功能基本都會有，并且要更好用。

快捷調試：類似 Postman 的接口調試方式，主要用途為臨時調試一些無需文檔化的接口，無需提前定義接口即可快速調試。

代碼生成：根據接口及數據數據模型定義，系統自動生成接口請求代碼、前端業務代碼及后端業務代碼。

團隊協作：Apifox 天生就是為團隊協作而生的，接口云端實時同步更新，成熟的團隊/項目/成員權限管理，滿足各類企業的需求。

Apifox 根據接口定義里的數據結構、數據類型，自動生成 mock 規則。

Apifox 內置智能 mock 規則庫，根據字段名、字段數據類型，智能優化自動生成的 mock 規則。如：名稱包含字符串image的string類型字段，自動 mock 出一個圖片地址 URL；包含字符串time的string類型字段，自動 mock 出一個時間字符串；包含字符串city的string類型字段，自動 mock 出一個城市名。

Apifox 根據內置規則，可自動識別出圖片、頭像、用戶名、手機號、網址、日期、時間、時間戳、郵箱、省份、城市、地址、IP 等字段，從而 Mock 出非常人性化的數據。

除了內置 mock 規則，用戶還可以自定義規則庫，滿足各種個性化需求。支持使用 正則表達式、通配符 來匹配字段名自定義 mock 規則。

支持導出 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等數據格式，方便舊項目遷移。

發布 Apifox WEB 版，支持在瀏覽器端使用 Apifox。

接口性能測試支持（類似 JMeter）。

支持插件市場，可以自己開發插件。

開放 Apifox API，允許開發者通過 API 調用 Apifox 的功能。

支持更多接口協議，如GraphQL、gRPC、websocket等。

支持離線使用，項目可選擇在線同步（團隊協作）還是僅本地存儲（單機離線使用）。