扔掉 Postman,Apifox 才是 YYDS!

作為軟件開發(fā)從業(yè)者，API 調(diào)試是必不可少的一項技能，在這方面 Postman 做的非常出色。但是在整個軟件開發(fā)過程中，API 調(diào)試只是其中的一部分，還有很多事情 Postman 無法完成，或者無法高效完成，比如：API 文檔定義、API Mock、API 自動化測試等等。Apifox 就是為了解決這個問題而生的。

接口管理現(xiàn)狀

一、常用解決方案

1. 使用 Swagger 管理 API 文檔
2. 使用 Postman 調(diào)試 API
3. 使用 MockJs 等工具 Mock API 數(shù)據(jù)
4. 使用 JMeter 做 API 自動化測試

二、存在的問題

維護不同工具之間數(shù)據(jù)一致性非常困難、低效。并且這里不僅僅是工作量的問題，更大的問題是多個系統(tǒng)之間數(shù)據(jù)不一致，導(dǎo)致協(xié)作低效、頻繁出問題，開發(fā)測試人員痛苦不堪。

1. 開發(fā)人員在 Swagger 定義好文檔后，接口調(diào)試的時候還需要去 Postman 再定義一遍。
2. 前端開發(fā) Mock 數(shù)據(jù)的時候又要去 MockJs 定義一遍，還需要手動設(shè)置 Mock 規(guī)則。
3. 測試人員需要去 JMeter 再定義一遍。
4. 前端根據(jù) MockJs Mock 出來的數(shù)據(jù)開發(fā)完，后端根據(jù) Swagger 定義的接口文檔開發(fā)完，各自都試測試通過了，本以為可以馬上上線，結(jié)果一對接發(fā)現(xiàn)各種問題：

• 開發(fā)過程中接口變更了，只修改了 Swagger，但是沒有及時同步修改 MockJs。
• 后端開發(fā)的接口數(shù)據(jù)類型和文檔不一致，肉眼難以發(fā)現(xiàn)問題。

同樣，測試在 JMeter 寫好的測試用例，真正運行的時候也會發(fā)現(xiàn)各種不一致。時間久了，各種不一致會越來越嚴重。

Apifox 解決方案

一、如何解決這些問題

1、Apifox 定位

Apifox = Postman + Swagger + Mock + JMeter

Apifox 是 API 文檔、API 調(diào)試、API Mock、API 自動化測試一體化協(xié)作平臺。

通過一套系統(tǒng)、一份數(shù)據(jù)，解決多個系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好接口文檔，接口調(diào)試、數(shù)據(jù) Mock、接口測試就可以直接使用，無需再次定義；接口文檔和接口開發(fā)調(diào)試使用同一個工具，接口調(diào)試完成后即可保證和接口文檔定義完全一致。高效、及時、準確！

2、Apifox 宗旨

節(jié)省研發(fā)團隊的每一分鐘！

3、Apifox 功能

1. 接口設(shè)計：Apifox 接口文檔遵循 OpenApi 3.0 (原 Swagger)、JSON Schema 規(guī)范的同時，提供了非常好用的可視化文檔管理功能，零學(xué)習(xí)成本，非常高效。并且支持在線分享接口文檔。
2. 數(shù)據(jù)模型：可復(fù)用的數(shù)據(jù)結(jié)構(gòu)，定義接口返回數(shù)據(jù)結(jié)構(gòu)及請求參數(shù)數(shù)據(jù)結(jié)構(gòu)（僅 JSON 和 XML 模式）時可直接引用。支持模型直接嵌套引用，直接 JSON/XML 智能導(dǎo)入，支持 oneOf、allOf 等高級組合模式。
3. 接口調(diào)試：Postman 有的功能，比如環(huán)境變量、前置/后置腳本、Cookie/Session 全局共享 等功能，Apifox 都有，并且比 Postman 更高效好用。接口運行完之后點擊保存為用例按鈕，即可生成接口用例，后續(xù)可直接運行接口用例，無需再輸入?yún)?shù)，非常方便。自定義腳本 100% 兼容 Postman 語法，并且支持運行 javascript、java、python、php、js、BeanShell、go、shell、ruby、lua 等各種語言代碼。
4. 接口用例：通常一個接口會有多種情況用例，比如參數(shù)正確用例、參數(shù)錯誤用例、數(shù)據(jù)為空用例、不同數(shù)據(jù)狀態(tài)用例等等。運行接口用例時會自動校驗數(shù)據(jù)正確性，用接口用例來調(diào)試接口非常高效。
5. 接口數(shù)據(jù) Mock：內(nèi)置 Mock.js 規(guī)則引擎，非常方便 mock 出各種數(shù)據(jù)，并且可以在定義數(shù)據(jù)結(jié)構(gòu)的同時寫好 mock 規(guī)則。支持添加“期望”，根據(jù)請求參數(shù)返回不同 mock 數(shù)據(jù)。最重要的是 Apifox 零配置 即可 Mock 出非常人性化的數(shù)據(jù)，具體在本文后面介紹。
6. 數(shù)據(jù)庫操作：支持讀取數(shù)據(jù)庫數(shù)據(jù)，作為接口請求參數(shù)使用。支持讀取數(shù)據(jù)庫數(shù)據(jù)，用來校驗(斷言)接口請求是否成功。
7. 接口自動化測試：提供接口集合測試，可以通過選擇接口（或接口用例）快速創(chuàng)建測試集。目前接口自動化測試更多功能還在開發(fā)中，敬請期待！目標是：JMeter 有的功能基本都會有，并且要更好用。
8. 快捷調(diào)試：類似 Postman 的接口調(diào)試方式，主要用途為臨時調(diào)試一些無需文檔化的接口，無需提前定義接口即可快速調(diào)試。
9. 代碼生成：根據(jù)接口及數(shù)據(jù)數(shù)據(jù)模型定義，系統(tǒng)自動生成接口請求代碼、前端業(yè)務(wù)代碼及后端業(yè)務(wù)代碼。
10. 團隊協(xié)作：Apifox 天生就是為團隊協(xié)作而生的，接口云端實時同步更新，成熟的團隊/項目/成員權(quán)限管理，滿足各類企業(yè)的需求。

二、Apifox 做的不僅僅是數(shù)據(jù)打通

如果你認為 Apifox 只做了數(shù)據(jù)打通，來提升研發(fā)團隊的效率，那就錯了。Apifox 還做了非常多的創(chuàng)新，來提升開發(fā)人員的效率。

1、接口支持“用例管理”

通常一個接口會有多種情況用例，比如 正確用例 參數(shù)錯誤用例 數(shù)據(jù)為空用例 不同數(shù)據(jù)狀態(tài)用例。定義接口的時候定義好這些不同狀態(tài)的用例，接口調(diào)試的時候直接運行，非常高效。

2、“數(shù)據(jù)模型”定義、引用

可以獨立定義數(shù)據(jù)模型，接口定義時可以直接引用數(shù)據(jù)模型，數(shù)據(jù)模型之間也可以相互引用。同樣的數(shù)據(jù)結(jié)構(gòu)，只需要定義一次即可多處使用；修改的時候只需要修改一處，多處實時更新，避免不一致。

3、調(diào)試時“自動校驗”數(shù)據(jù)結(jié)構(gòu)

使用 Apifox 調(diào)試接口的時候，系統(tǒng)會根據(jù)接口文檔里的定義，自動校驗返回的數(shù)據(jù)結(jié)構(gòu)是否正確，無需通過肉眼識別，也無需手動寫斷言腳本檢測，非常高效！

Apifox 自動校驗數(shù)據(jù)結(jié)構(gòu)

4、“可視化”設(shè)置斷言

設(shè)置斷言：

Apifox 設(shè)置斷言

運行后，查看斷言結(jié)果：

5、“可視化”設(shè)置提取變量

6、支持數(shù)據(jù)庫操作

7、“零配置”Mock 出非常人性化的數(shù)據(jù)

先放一張圖對比下 Apifox 和其他同類工具 零配置 mock 出來的數(shù)據(jù)效果：

Apifox Mock 數(shù)據(jù)結(jié)果對比同類工具

可以看出 Apifox 零配置 Mock 出來的數(shù)據(jù)和真實情況是非常接近的，前端開發(fā)可以直接使用，而無需再手動寫 mock 規(guī)則。

Apifox 如何做到高效率、零配置生成非常人性化的 mock 數(shù)據(jù)

1. Apifox 根據(jù)接口定義里的數(shù)據(jù)結(jié)構(gòu)、數(shù)據(jù)類型，自動生成 mock 規(guī)則。
2. Apifox 內(nèi)置智能 mock 規(guī)則庫，根據(jù)字段名、字段數(shù)據(jù)類型，智能優(yōu)化自動生成的 mock 規(guī)則。如：名稱包含字符串image的string類型字段，自動 mock 出一個圖片地址 URL；包含字符串time的string類型字段，自動 mock 出一個時間字符串；包含字符串city的string類型字段，自動 mock 出一個城市名。
3. Apifox 根據(jù)內(nèi)置規(guī)則，可自動識別出圖片、頭像、用戶名、手機號、網(wǎng)址、日期、時間、時間戳、郵箱、省份、城市、地址、IP 等字段，從而 Mock 出非常人性化的數(shù)據(jù)。
4. 除了內(nèi)置 mock 規(guī)則，用戶還可以自定義規(guī)則庫，滿足各種個性化需求。支持使用 正則表達式、通配符 來匹配字段名自定義 mock 規(guī)則。

8、生成在線接口文檔

Apifox 項目可“在線分享” API 文檔，分享出去的 API 文檔可設(shè)置為公開或需要密碼訪問，非常方便與外部團隊協(xié)作。

體驗地址：https://www.apifox.cn/apidoc/shared-ce387612-cfdb-478a-b604-b96d1dbc511b/http/5041285

9、代碼自動生成

根據(jù)接口模型定義，自動生成各種語言/框架（如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等）的業(yè)務(wù)代碼（如 Model、Controller、單元測試代碼等）和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動生成。

更重要的是：你可以通過自定義代碼模板來生成符合自己團隊的架構(gòu)規(guī)范的代碼，滿足各種個性化的需求。

10、導(dǎo)入、導(dǎo)出

1. 支持導(dǎo)出 OpenApi (Swagger)、Markdown、Html 等數(shù)據(jù)格式，因為可以導(dǎo)出OpenApi格式數(shù)據(jù)，所以你可以利用 OpenApi (Swagger) 豐富的生態(tài)工具完成各種接口相關(guān)的事情。
2. 支持導(dǎo)入 OpenApi (Swagger)、Postman、apiDoc、HAR、RAML、RAP2、YApi、Eolinker、NEI、DOClever、ApiPost 、Apizza 、ShowDoc、API Blueprint、I/O Docs、WADL、Google Discovery等數(shù)據(jù)格式，方便舊項目遷移。
3. 支持定時自動導(dǎo)入OpenApi (Swagger)、apiDoc、Apifox格式數(shù)據(jù)。

三、后續(xù)功能規(guī)劃

1. 發(fā)布 Apifox WEB 版，支持在瀏覽器端使用 Apifox。
2. 接口性能測試支持（類似 JMeter）。
3. 支持插件市場，可以自己開發(fā)插件。
4. 開放 Apifox API，允許開發(fā)者通過 API 調(diào)用 Apifox 的功能。
5. 支持更多接口協(xié)議，如GraphQL、gRPC、websocket等。
6. 支持離線使用，項目可選擇在線同步（團隊協(xié)作）還是僅本地存儲（單機離線使用）。

四、更多 Apifox 功能截圖

接口調(diào)試Apifox 多種主題色可選

五、 Apifox 交流群

掃二維碼加微信，拉你進官方微信群，各種使用過程中的疑問，官方工作人員貼心為你解答：：

六、 Apifox 下載地址

介紹了Apifox這么多實用的功能，用上了才是真福利！軟件完全免費，堪稱國產(chǎn)良心，有興趣有需求的小伙伴，完全可以直接復(fù)制下面的鏈接，粘貼到瀏覽器打開即可下載，或者點擊閱讀原文直達！?

官網(wǎng)地址：https://www.apifox.cn/?utm_source=javahxjs