是時(shí)候扔掉 Postman 了,Apifox 真香!
作為開軟件開發(fā)從業(yè)者,接口調(diào)試是必不可少的一項(xiàng)技能,我們經(jīng)常使用 Postman 工具來進(jìn)行接口調(diào)試,在接口調(diào)試方面 Postman 做的非常出色。但是在整個(gè)軟件開發(fā)過程中,接口調(diào)試只是其中的一部分,還有很多事情 Postman 無法完成,或者
無法高效完成,比如:接口文檔定義、Mock 數(shù)據(jù)、接口自動(dòng)化測試等等。
接口管理現(xiàn)狀
一、常用解決方案
使用 Swagger 管理接口文檔
使用 Postman 調(diào)試接口
使用 RAP Mock 數(shù)據(jù)
使用 JMeter 做接口自動(dòng)化測試
二、存在的問題
維護(hù)不同工具之間數(shù)據(jù)一致性非常困難、非常低效。并且這里不僅僅是工作量的問題,更大的問題是多個(gè)系統(tǒng)之間數(shù)據(jù)不一致,導(dǎo)致協(xié)作低效,頻繁出問題,開發(fā)人員痛苦不堪。
開發(fā)人員在 Swagger 定義好文檔后,接口調(diào)試的時(shí)候還需要去 Postman 再定義一遍。
前端開發(fā) Mock 數(shù)據(jù)的時(shí)候又要去 RAP 定義一遍,手動(dòng)設(shè)置好 Mock 規(guī)則。
測試人員需要去 JMeter 定義一遍。
前端根據(jù) RAP Mock 出來的數(shù)據(jù)開發(fā)完,后端根據(jù) Swagger 定義的接口文檔開發(fā)完,各自測試測試通過了,本以為可以馬上上線,結(jié)果一對接發(fā)現(xiàn)各種問題:原來開發(fā)過程中接口變更,只修改了 Swagger,但是沒有及時(shí)同步修改 RAP。
同樣,測試在 JMeter 寫好的測試用例,真正運(yùn)行的時(shí)候也會(huì)發(fā)現(xiàn)各種不一致。
時(shí)間久了,各種不一致會(huì)越來越嚴(yán)重。
Apifox 解決方案
一、如何解決這些問題
1、Apifox 定位
Apifox = Postman + Swagger + Mock + JMeter
通過一套系統(tǒng)、一份數(shù)據(jù),解決多個(gè)系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好接口文檔,接口調(diào)試、數(shù)據(jù) Mock、接口測試就可以直接使用,無需再次定義;接口文檔和接口開發(fā)調(diào)試使用同一個(gè)工具,接口調(diào)試完成后即可保證和接口文檔定義完全一致。高效、及時(shí)、準(zhǔn)確!
2、Apifox ?功能
接口文檔定義:Apifox 遵循 OpenApi 3.0 (原Swagger)、JSON Schema 規(guī)范的同時(shí),提供了非常好用的可視化文檔管理功能,零學(xué)習(xí)成本,非常高效。
接口調(diào)試:Postman 有的功能,比如環(huán)境變量、預(yù)執(zhí)行腳本、后執(zhí)行腳本、Cookie/Session 全局共享 等功能,Apifox 都有,并且和 Postman 一樣高效好用。
數(shù)據(jù) Mock:內(nèi)置 Mock.js 規(guī)則引擎,非常方便 mock 出各種數(shù)據(jù),并且可以在定義數(shù)據(jù)結(jié)構(gòu)的同時(shí)寫好 mock 規(guī)則。支持添加“期望”,根據(jù)請求參數(shù)返回不同 mock 數(shù)據(jù)。最重要的是 Apifox
零配置即可 Mock 出非常人性化的數(shù)據(jù),具體在本文后面介紹。接口自動(dòng)化測試:提供接口集合測試,可以通過選擇接口(或接口用例)快速創(chuàng)建測試集。目前接口自動(dòng)化測試更多功能還在開發(fā)中,敬請期待!目標(biāo)是:JMeter 有的功能基本都會(huì)有,并且要更好用。
二、Apifox 做的不僅僅是數(shù)據(jù)打通
如果你認(rèn)為 Apifox 只做了數(shù)據(jù)打通,來提升研發(fā)團(tuán)隊(duì)的效率,那就錯(cuò)了。Apifox 還做了非常多的創(chuàng)新,來提升開發(fā)人員的效率。
1、調(diào)試時(shí)自動(dòng)校驗(yàn)數(shù)據(jù)結(jié)構(gòu)
使用 Apifox 調(diào)試接口的時(shí)候,系統(tǒng)會(huì)根據(jù)接口文檔里的定義,自動(dòng)校驗(yàn)返回的數(shù)據(jù)結(jié)構(gòu)是否正確,無需通過肉識(shí)別,也無需手動(dòng)寫斷言腳本檢測,非常高效!

2、數(shù)據(jù)模型定義、引用
可以獨(dú)立定義數(shù)據(jù)模型,接口定義時(shí)可以直接引用數(shù)據(jù)模型,數(shù)據(jù)模型之間也可以相互引用。同樣的數(shù)據(jù)結(jié)構(gòu),只需要定義一次即可多處使用;修改的時(shí)候只需要修改一處,多處實(shí)時(shí)更新,避免不一致。
3、接口用例管理
通常一個(gè)接口會(huì)有多種情況用例,比如 正確用例 參數(shù)錯(cuò)誤用例 數(shù)據(jù)為空用例 不同數(shù)據(jù)狀態(tài)用例。定義接口的時(shí)候定義好這些不同狀態(tài)的用例,接口調(diào)試的時(shí)候直接運(yùn)行,非常高效。
4、零配置 Mock 出非常人性化的數(shù)據(jù)
先放一張圖對比下 Apifox 和其他同類工具 零配置 mock 出來的數(shù)據(jù)效果:


可以看出 Apifox 零配置 Mock 出來的數(shù)據(jù)和真實(shí)情況是非常接近的,前端開發(fā)可以直接使用,而無需再手動(dòng)寫mock規(guī)則。
Apifox 如何做到高效率、零配置生成非常人性化的 mock 數(shù)據(jù):
Apifox 根據(jù)接口定義里的數(shù)據(jù)結(jié)構(gòu)、數(shù)據(jù)類型,自動(dòng)生成 mock 規(guī)則。
Apifox 內(nèi)置智能 mock 規(guī)則庫,根據(jù)字段名、字段數(shù)據(jù)類型,智能優(yōu)化自動(dòng)生成的 mock 規(guī)則。如:名稱包含字符串
image的string類型字段,自動(dòng) mock 出一個(gè)圖片地址 URL;包含字符串time的string類型字段,自動(dòng) mock 出一個(gè)時(shí)間字符串;包含字符串city的string類型字段,自動(dòng) mock 出一個(gè)城市名。Apifox 根據(jù)內(nèi)置規(guī)則,可自動(dòng)識(shí)別出圖片、頭像、用戶名、手機(jī)號(hào)、網(wǎng)址、日期、時(shí)間、時(shí)間戳、郵箱、省份、城市、地址、IP等字段,從而 Mock 出非常人性化的數(shù)據(jù)。
除了內(nèi)置 mock 規(guī)則,用戶還可以自定義規(guī)則庫,滿足各種個(gè)性化需求。支持使用
正則表達(dá)式、通配符來匹配字段名自定義 mock 規(guī)則。
5、代碼自動(dòng)生成
根據(jù)接口模型定義,自動(dòng)生成各種語言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的業(yè)務(wù)代碼(如 Model、Controller、單元測試代碼等)和接口請求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動(dòng)生成。
更重要的是:你可以通過自定義代碼模板來生成符合自己團(tuán)隊(duì)的架構(gòu)規(guī)范的代碼,滿足各種個(gè)性化的需求。
6、導(dǎo)入、導(dǎo)出
支持導(dǎo)出
OpenApi (原Swagger)、Markdown、Html等數(shù)據(jù)格式,因?yàn)榭梢詫?dǎo)出OpenApi格式數(shù)據(jù),所以你可以利用 OpenApi (Swagger) 豐富的生態(tài)工具完成各種接口相關(guān)的事情。支持導(dǎo)入
OpenApi (原Swagger)、Postman、HAR、RAML、RAP2、YApi、Eolinker、DOClever、ApiPost、Apizza、API Blueprint、I/O Docs、WADL、Google Discovery等數(shù)據(jù)格式,方便舊項(xiàng)目遷移。
三、更多 Apifox 功能截圖
















Apifox 官網(wǎng)地址
Apifox 官網(wǎng):apifox.cn,點(diǎn)擊下方 “閱讀原文” 即可訪問。
