國產API管理神器 Apifox 好用嗎？
- PHP中文网原創
- 2022-07-26 20:44:293929瀏覽
作為軟體開發從業者，API 調試是必不可少的一項技能，在這方面 Postman 所做的非常出色。但在整個軟體開發過程中，API 偵錯只是其中的一部分，還有很多事情 Postman 無法完成，或是無法有效率地完成，例如：API 文件定義、API Mock、API 自動化測試等等。 Apifox 就是為了解決這個問題而生的。
介面管理現況
一、常用解決方案
1、使用Swagger 管理API 文件使用
2、Postman 偵錯API使用MockJs 等工具
3、 Mock API 資料使用
4、 JMeter 做API 自動化測試
二、存在的問題
維護不同工具之間資料一致性非常困難、低效。而這裡不僅僅是工作量的問題，更大的問題是多個系統之間資料不一致，導致協作低效、頻繁出問題，開發測試人員痛苦不堪。
開發人員在 Swagger 定義好文件後，介面偵錯的時候還需要去 Postman 再定義一次。前端開發 Mock 資料的時候又要去 MockJs 定義一遍，還需要手動設定 Mock 規則。測試人員需要去 JMeter 再定義一次。前端根據MockJs Mock 出來的資料開發完，後端根據Swagger 定義的介面文件開發完，各自都試測試通過了，本來以為可以馬上上線，結果一對接發現各種問題：開發過程中介面變更了，只修改了Swagger，但是沒有及時同步修改MockJs。後端開發的介面資料類型和文件不一致，肉眼難以發現問題。同樣，測試在 JMeter 寫好的測試案例，真正運作的時候也會發現各種不一致。時間久了，各種不一致會越來越嚴重。
Apifox 解決方案：下載位址
#一、如何解決這些問題
##1、 Apifox 定位
Apifox = Postman Swagger Mock JMeterApifox 是API 文件、API 偵錯、API Mock、API 自動化測試整合式協作平台。 透過一套系統、一份數據，解決多個系統之間的資料同步問題。只要定義好接口文檔，接口調試、數據 Mock、接口測試就可以直接使用，無需再次定義；接口文檔和接口開發調試使用同一個工具，接口調試完成後即可保證和接口文檔定義完全一致。高效、及時、準確！2、Apifox 宗旨
節省研發團隊的每一分鐘！3、Apifox 功能#
介面設計：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 做的不只是資料打通
如果你認為 Apifox 只做了資料打通，來提升研發團隊的效率，那就錯了。 Apifox 也做了非常多的創新，來提升開發人員的效率。
1、介面支援「用例管理」
通常一個介面會有多種情況用例，例如正確用例參數錯誤用例資料為空白用例不同資料狀態用例。定義介面的時候定義好這些不同狀態的用例，介面調試的時候直接運行，非常有效率。
2、「資料模型」定義、引用
可以獨立定義資料模型，介面定義時可以直接引用資料模型，資料模型之間也可以互相引用。同樣的資料結構，只需要定義一次即可多處使用；修改的時候只需要修改一處，多處即時更新，避免不一致。
3、偵錯時「自動校驗」資料結構
使用Apifox 偵錯介面的時候，系統會根據介面文件裡的定義，自動校驗回傳的資料結構是否正確，無需透過肉眼識別，也無需手動寫入斷言腳本檢測，非常有效率！
Apifox 自動校驗資料結構
4、「視覺化」設定斷言
設定斷言：
Apifox 設定斷言
運行後，查看斷言結果：
5、「視覺化」設定提取變數
6、支援資料庫操作
7、「零配置」Mock 出非常人性化的資料
先放一張圖比較下Apifox 和其他同類工具零配置mock 出來的數據效果：
Apifox Mock 數據結果比較同類工具
#可以看出Apifox 零配置Mock 出來的資料和真實情況是非常接近的，前端開發可以直接使用，而無需再手動寫mock 規則。
Apifox 如何做到高效率、零配置產生非常人性化的 mock 資料
Apifox 根據介面定義裡的資料結構、資料類型，自動產生 mock 規則。 Apifox 內建智慧型 mock 規則庫，依據欄位名稱、欄位資料類型，智慧優化自動產生的 mock 規則。如：名稱包含字符串image的string類型字段，自動mock 出一個圖片地址URL；包含字符串time的string類型字段，自動mock 出一個時間字符串；包含字符串city的string類型字段，自動mock 出一個城市名。 Apifox 根據內建規則，可自動識別圖片、頭像、使用者名稱、手機號碼、網址、日期、時間、時間戳記、郵箱、省份、城市、地址、IP 等字段，從而 Mock 出非常人性化的資料。除了內建 mock 規則，使用者還可以自訂規則庫，滿足各種個人化需求。支援使用 正規表示式、通配符 來符合欄位名稱自訂 mock 規則。
8、產生線上介面文檔
Apifox 專案可「線上分享」 API 文件，分享的API 文件可設定為公開或需要密碼訪問，非常方便與外部團隊協作。
體驗網址：https://www.apifox.cn/apidoc/shared-ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285
#9、程式碼自動產生
依介面模型定義，自動產生各種語言/框架（如TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、 Dart、C 、C#、Rust 等）的業務代碼（如Model、Controller、單元測試程式碼等）和介面請求碼。目前 Apifox 支援 130 種語言及框架的程式碼自動產生。 
10、匯入、匯出
支援匯出OpenApi (Swagger)、Markdown、Html 等資料格式，因為可以匯出OpenApi格式數據，所以可以利用OpenApi ( Swagger) 豐富的生態工具完成各種介面相關的事情。支援導入OpenApi (Swagger)、Postman、apiDoc、HAR、RAML、RAP2、YApi、Eolinker、NEI、DOClever、ApiPost 、Apizza 、ShowDoc、API Blueprint、I/O Docs、WADL、Google Discovery等資料格式，方便舊專案遷移。支援定時自動匯入OpenApi (Swagger)、apiDoc、Apifox格式資料。
三、後續功能規劃
介面偵錯
#自訂mock規則
