推薦一款技術(shù)人必備的接口測(cè)試神器:Apifox

1. 背景
作為互聯(lián)網(wǎng)行業(yè)技術(shù)從業(yè)者,接口調(diào)試是必不可少的一項(xiàng)技能,通常我們都會(huì)選擇使用 Postman 這類工具來進(jìn)行接口調(diào)試,在接口調(diào)試方面 Postman 做的確實(shí)非常出色。
但是在整個(gè)軟件開發(fā)過程中,接口調(diào)試只是其中的一部分,還有很多事情 Postman 是無法完成的,或者無法高效完成,比如:接口文檔定義、Mock 數(shù)據(jù)、接口自動(dòng)化測(cè)試等等。
今天給大家推薦的一款神器: Apifox,它是集:接口文檔管理、接口調(diào)試、Mock、接口自動(dòng)化測(cè)試于一體的。有的讀者咋一看,會(huì)覺得和YAPI有點(diǎn)類似,但兩者在功能特色上,只能說是各有千秋的。
細(xì)心的讀者,會(huì)發(fā)現(xiàn)文章,讀到這里,本文就已經(jīng)為大家推薦了三款效率神器:
Apifox、Postwoman、YAPI。
2. 聊一聊接口管理的現(xiàn)狀
對(duì)于接口管理的現(xiàn)狀來說,目前行業(yè)大部分采取的解決方案有如下幾種:
- 使用
Swagger管理接口文檔。- 使用
Postman調(diào)試接口。- 使用
RAP或Easy Mock來進(jìn)行Mock數(shù)據(jù)。- 使用
JMeter做接口自動(dòng)化測(cè)試。
而上述的接口管理手段,咋一看,貌似沒有什么問題,但仔細(xì)分析,不難發(fā)現(xiàn),當(dāng)中存在的問題還真不少,比如要維護(hù)不同工具,并且這些工具之間數(shù)據(jù)一致性非常困難、非常低效。這里不僅僅是工作量的問題,更大的問題是多個(gè)系統(tǒng)之間數(shù)據(jù)不一致,導(dǎo)致協(xié)作低效,頻繁出問題,開發(fā)人員、測(cè)試人員工作起來也痛苦不堪。
設(shè)想一下這樣的一個(gè)協(xié)作流程(官方示例):
1. 開發(fā)人員在
Swagger定義好文檔后,接口調(diào)試的時(shí)候還需要去Postman再定義一遍。
2. 前端開發(fā)Mock數(shù)據(jù)的時(shí)候又要去RAP或Easy Mock定義一遍,手動(dòng)設(shè)置好Mock規(guī)則。
3. 測(cè)試人員需要去JMeter定義一遍。
4. 前端根據(jù)RAP或Easy Mock定義Mock出來的數(shù)據(jù)開發(fā)完,后端根據(jù)Swagger定義的接口文檔開發(fā)完,各自測(cè)試測(cè)試通過了,本以為可以馬上上線,結(jié)果一對(duì)接發(fā)現(xiàn)各種問題:原來開發(fā)過程中接口變更,只修改了Swagger,但是沒有及時(shí)同步修改RAP或Easy Mock。
5. 同樣,測(cè)試在JMeter寫好的測(cè)試用例,真正運(yùn)行的時(shí)候也會(huì)發(fā)現(xiàn)各種不一致。
6. 時(shí)間久了,各種不一致會(huì)越來越嚴(yán)重。
3. Apifor介紹
官方對(duì)Apifor定位是,Apifox = Postman + Swagger + Mock + JMeter,如下圖所示

Apifox目標(biāo)是通過一套系統(tǒng)、一份數(shù)據(jù),解決多個(gè)系統(tǒng)之間的數(shù)據(jù)同步問題。只要定義好接口文檔,接口調(diào)試、數(shù)據(jù) Mock、接口測(cè)試就可以直接使用,無需再次定義;接口文檔和接口開發(fā)調(diào)試使用同一個(gè)工具,接口調(diào)試完成后即可保證和接口文檔定義完全一致。高效、及時(shí)、準(zhǔn)確!
官方地址:https://www.apifox.cn/#
概括來講,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ù)請(qǐng)求參數(shù)返回不同 mock 數(shù)據(jù)。最重要的是 Apifox
零配置即可 Mock 出非常人性化的數(shù)據(jù),具體在本文后面介紹。
- 接口自動(dòng)化測(cè)試:提供接口集合測(cè)試,可以通過選擇接口(或接口用例)快速創(chuàng)建測(cè)試集。目前接口自動(dòng)化測(cè)試更多功能還在開發(fā)中!目標(biāo)是:JMeter 有的功能基本都會(huì)有,并且要更好用。

4. Apifor小試牛刀
接下來,帶著大家,簡(jiǎn)單體驗(yàn)一下Apifor的使用。
1、先在官網(wǎng)下載對(duì)應(yīng)系統(tǒng)安裝包,進(jìn)行安裝,安裝完成后,第一次啟動(dòng)需要先登錄。

Ps: 登錄前,需要先通過郵箱來注冊(cè)一個(gè)帳號(hào)。
2? 登錄成功后,Apifox默認(rèn)給了一些例子,單純看它的界面會(huì)發(fā)現(xiàn)和Postman界面比較相似。

Ps: 當(dāng)然也不要被它的外表所欺騙,功能還是有別于Postman的。
3?在本地啟一個(gè)API服務(wù),端口為8000, 在Apifor上,新建一個(gè)新的測(cè)試環(huán)境,如下所示:

4?新建一個(gè)測(cè)試分類如:接口測(cè)試,也可直接在默認(rèn)分類上,新建一條接口用例,如下所示:

如上圖,添加對(duì)應(yīng)的基礎(chǔ)信息、配置請(qǐng)求參數(shù)等。
5?選擇測(cè)試環(huán)境,點(diǎn)擊發(fā)送按鈕,運(yùn)行接口測(cè)試用例。

看到這里,可能有些讀者覺得和Postman功能基本是一樣的,不妨接著往下看。
5. Apifor更多特性
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)寫斷言腳本檢測(cè),非常高效!

根據(jù)官方的示例可以看出,在運(yùn)行集合測(cè)試時(shí),可以結(jié)合自動(dòng)校驗(yàn)數(shù)據(jù)結(jié)構(gòu)的功能, 清晰展示出失敗用例校驗(yàn)不通過的原因。

2?零配置 Mock 出非常人性化的數(shù)據(jù)
1? 為上述示例,添加一個(gè)mock測(cè)試服務(wù),配置如下所示:

按照接口字段數(shù)據(jù)格式要求,根據(jù)mock.js語法,配置保存完畢,運(yùn)行后,自動(dòng)生成一個(gè)mock服務(wù)。

其中,Mock.js語法示例可見:http://mockjs.com/examples.html
可以看出 Apifox 零配置 Mock 出來的數(shù)據(jù)和真實(shí)情況是非常接近的,前端開發(fā)可以直接使用,而無需再手動(dòng)寫mock規(guī)則。
3?代碼自動(dòng)生成
根據(jù)接口模型定義,自動(dòng)生成各種語言/框架(如 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等)的業(yè)務(wù)代碼(如 Model、Controller、單元測(cè)試代碼等)和接口請(qǐng)求代碼。目前 Apifox 支持 130 種語言及框架的代碼自動(dòng)生成。

更重要的是:你可以通過自定義代碼模板來生成符合自己團(tuán)隊(duì)的架構(gòu)規(guī)范的代碼,滿足各種個(gè)性化的需求。
4?導(dǎo)入、導(dǎo)出
1. 支持導(dǎo)出 OpenApi (原Swagger)、Markdown、Html 等數(shù)據(jù)格式,因?yàn)榭梢詫?dǎo)出OpenApi格式數(shù)據(jù),所以你可以利用 OpenApi (Swagger) 豐富的生態(tài)工具完成各種接口相關(guān)的事情。
2. 支持導(dǎo)入 OpenApi (原Swagger)、Postman、HAR、RAP2、yapi、Eolinker、DOClever、ApiPost 、Apizza 等數(shù)據(jù)格,方便遷移舊項(xiàng)目。

6. 小結(jié)
雖然Apifox目前有些功能還并不完善,但整的來說,Apifox還是不錯(cuò)的,也為接口開發(fā)調(diào)試測(cè)試提供了一種效率更佳的的解決方案,按照Apifox開發(fā)團(tuán)隊(duì)后續(xù)規(guī)劃,后續(xù)會(huì)重加增加接口性能測(cè)試能力支持(類似JMeter)、支持離線團(tuán)隊(duì)多人協(xié)作等特性。