# 1. 背景 作為網際網路行業技術從業者，介面除錯是必不可少的一項技能，通常我們都會選擇使用 Postman 這類工具來進行介面除錯，在介面除錯方面 Postman 做的確實非常出色。當然除了Postman，還有它的老婆: **`Postwoman`**也同樣很出色，公號之前有發表過一篇關於它老婆**`Postwoman`**使用的文章，詳細可閱：[推薦一款 Postman 的開源替代品： Postwoman](https://mp.weixin.qq.com/s/8viBJ46-5-POvMftNfY-Eg) 但是在整個軟體開發過程中，介面除錯只是其中的一部分，還有很多事情 Postman 是無法完成的，或者**無法高效完成**，比如：介面文件定義、Mock 資料、介面自動化測試等等。 今天給大家推薦的一款神器: **Apifox**，它是集：**`介面文件管理`**、**`介面除錯`**、**`Mock`**、**`介面自動化測試`**於一體的。有的讀者咋一看，會覺得和**`YAPI`**有點類似，但兩者在功能特色上，只能說是各有千秋的。 > 細心的讀者，會發現文章，正文乾貨還沒有開始，就已經為大家推薦了三款效率神器: Apifox、Postwoman、YAPI。 # 2. 聊一聊介面管理的現狀 對於介面管理的現狀來說，目前行業大部分採取的解決方案有如下幾種： - 使用 Swagger 管理介面文件。 - 使用 Postman 除錯介面。 - 使用 RAP或Easy Mock來進行 Mock 資料。 - 使用 JMeter 做介面自動化測試。 上述的介面管理手段，咋一看，貌似沒有什麼問題，但仔細分析，不難發現，當中存在的問題還真不少，比如要維護不同工具，並且這些工具之間資料一致性非常困難、非常低效。這裡不僅僅是工作量的問題，更大的問題是多個系統之間資料不一致，導致協作低效，頻繁出問題，開發人員、測試人員痛苦不堪。 設想一下這樣的一個協作流程： 1. 開發人員在 Swagger 定義好文件後，介面除錯的時候還需要去 Postman 再定義一遍。 2. 前端開發 Mock 資料的時候又要去 RAP 或Easy Mock定義一遍，手動設定好 Mock 規則。 3. 測試人員需要去 JMeter 定義一遍。 4. 前端根據 RAP 或Easy Mock定義 Mock 出來的資料開發完，後端根據 Swagger 定義的介面文件開發完，各自測試測試通過了，本以為可以馬上上線，結果一對接發現各種問題：原來開發過程中介面變更，只修改了 Swagger，但是沒有及時同步修改 RAP 或Easy Mock。 5. 同樣，測試在 JMeter 寫好的測試用例，真正執行的時候也會發現各種不一致。 6. 時間久了，各種不一致會越來越嚴重。 # 3. Apifor介紹 官方對Apifor定位，**Apifox = Postman + Swagger + Mock + JMeter**，如下圖所示  `Apifox`目標是通過一套系統、一份資料，解決多個系統之間的資料同步問題。只要定義好介面文件，介面除錯、資料 Mock、介面測試就可以直接使用，無需再次定義；介面文件和介面開發除錯使用同一個工具，介面除錯完成後即可保證和介面文件定義完全一致。高效、及時、準確！ 官方地址：https://www.apifox.cn/# 概括來講，**Apifox常用 功能**分為四類功能： 1. **介面文件定義功能**：Apifox 遵循 [OpenApi](https://link.zhihu.com/?target=https%3A//www.openapis.org/) 3.0 (原Swagger)、[JSON Schema](https://link.zhihu.com/?target=https%3A//json-schema.org/) 規範的同時，提供了非常好用的視覺化文件管理功能，零學習成本，非常高效。 2. **介面除錯功能**：Postman 有的功能，比如環境變數、預執行指令碼、後執行指令碼、Cookie/Session 全域性共享 等功能，Apifox 都有，並且和 Postman 一樣高效好用。 3. **資料 Mock功能**：內建 [Mock.js](https://link.zhihu.com/?target=http%3A//mockjs.com/) 規則引擎，非常方便 mock 出各種資料，並且可以在定義資料結構的同時寫好 mock 規則。支援新增“期望”，根據請求引數返回不同 mock 資料。最重要的是 Apifox `零配置` 即可 Mock 出非常人性化的資料，具體在本文後面介紹。 4. **介面自動化測試**：提供介面集合測試，可以通過選擇介面（或介面用例）快速建立測試集。目前介面自動化測試更多功能還在開發中！目標是： JMeter 有的功能基本都會有，並且要更好用。  # 4. Apifor小試牛刀 接下來，帶著大家，來體驗一下Apifor的使用。 1、先在官網下載對應系統安裝包，進行安裝，安裝完成後，第一次啟動需要先登入。  Ps: 登入前，需要先通過郵箱來註冊一個帳號。 2､ 登入成功後，Apifox預設給了一些例子，如果看它的介面會發現和Postman介面比較相似。  > Ps: 當然也不要被它的外表所欺騙了，還是有別於Postman的。 3､在本地啟一個API服務，埠為8000, 在Apifor上，新建一個新的測試環境，如下所示：  4､新建一分類：`介面測試`，或直接在預設分類上，新建一條介面用例，如下所示  如上圖，新增對應的基礎資訊、配置請求引數等。 5､選擇測試環境，點選`傳送`按鈕，執行介面測試用例。  看到這裡，可能有些讀者覺得和Postman功能基本是一樣的，不妨接著往下看。 # 5. Apifor更多特性 ### 1、除錯時自動校驗資料結構 使用 Apifox 除錯介面的時候，系統會根據介面文件裡的定義，自動校驗返回的資料結構是否正確，無需通過肉識別，也無需手動寫斷言指令碼檢測，非常高效！  根據官方的示例可以看出，在執行集合測試時，可以結合自動校驗資料結構的功能， 清晰展示出失敗用例校驗不通過的原因。  ### **2､零配置 Mock 出非常人性化的資料** 1､ 為上述示例，新增一個mock測試服務，配置如下所示：  按照介面欄位資料格式要求，根據mock.js語法，配置儲存完畢，執行後，自動生成一個mock服務。  其中，Mock.js語法示例可見：http://mockjs.com/examples.html 可以看出 Apifox `零配置` Mock 出來的資料和真實情況是非常接近的，前端開發可以直接使用，而無需再手動寫mock規則。 ### 3､程式碼自動生成 根據介面模型定義，自動生成各種語言/框架（如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等）的業務程式碼（如 Model、Controller、單元測試程式碼等）和介面請求程式碼。目前 Apifox 支援 130 種語言及框架的程式碼自動生成。  更重要的是：你可以通過`自定義程式碼模板`來生成符合自己團隊的架構規範的程式碼，滿足各種個性化的需求。 ### 4､匯入、匯出 1. 支援匯出 `OpenApi (原Swagger)`、`Markdown`、`Html` 等資料格式，因為可以匯出`OpenApi`格式資料，所以你可以利用 OpenApi (Swagger) 豐富的生態工具完成各種介面相關的事情。 2. 支援匯入 `OpenApi (原Swagger)`、`Postman`、`HAR`、`RAP2`、`yapi`、`Eolinker`、`DOClever`、`ApiPost` 、`Apizza` 等資料格，方便遷移舊專案。  # 6. 小結 雖然Apifox目前有些功能還並不完善，但整的來說，Apifox還是不錯的，也為介面開發除錯測試提供了一種效率更佳的的解決方案，按照Apifox開發團隊後續規劃，後續會重加增加介面效能測試能力支援（類似JMeter）、支援離線團隊多人協作等特性。