目錄
Apifox簡(jiǎn)介
安裝
API文檔導(dǎo)入
接口管理
接口設(shè)計(jì)
接口調(diào)試
使用腳本
Mock數(shù)據(jù)
測(cè)試管理
主題設(shè)置
總結(jié)
重點(diǎn):配套學(xué)習(xí)資料和視頻教學(xué)
Apifox簡(jiǎn)介
Apifox 的定位是Postman + Swagger + Mock + JMeter
,具有API文檔管理、API調(diào)試、API Mock、API 自動(dòng)化測(cè)試等功能。可以通過(guò)一種工具解決之前使用多種工具的數(shù)據(jù)同步問(wèn)題。高效、及時(shí)、準(zhǔn)確!
安裝
- Apifox的安裝非常方便,直接下載安裝包解壓安裝即可。
- 官方非常貼心地提供了
示例項(xiàng)目
,直接打開(kāi)即可體驗(yàn)Apifox的功能,看下界面還是很漂亮的;
?
- 我們自己使用的話首先需要
新建團(tuán)隊(duì)
,便于團(tuán)隊(duì)成員之間協(xié)同工作;
- 然后在團(tuán)隊(duì)中
新建項(xiàng)目
,新建成功后我們就可以開(kāi)始使用Apifox的強(qiáng)大功能了!
API文檔導(dǎo)入
Apifox的API文檔導(dǎo)入功能非常強(qiáng)大,支持包括Swagger、Postman、YApi、ShowDoc等多達(dá)20種工具的導(dǎo)入。接下來(lái)我們通過(guò)使用之前
mall-tiny-swagger
項(xiàng)目中的接口,來(lái)體驗(yàn)下它的導(dǎo)入功能!
- 首先我們選擇
新建接口
按鈕,選擇導(dǎo)入
;
- 然后打開(kāi)導(dǎo)入界面,選擇
Swagger->URL導(dǎo)入
,輸入Swagger的數(shù)據(jù)URL;
- 導(dǎo)入時(shí)將顯示
導(dǎo)入預(yù)覽
,顯示要導(dǎo)入的接口
和數(shù)據(jù)模型
,Apifox將會(huì)把我們接口返回的實(shí)體類轉(zhuǎn)換為數(shù)據(jù)模型,以便進(jìn)行復(fù)用;
- 導(dǎo)入成功后界面效果如下,Apifox將查看文檔和修改文檔做了區(qū)分,方便我們管理接口文檔。
接口管理
雖然從Swagger中導(dǎo)入的接口文檔已經(jīng)很詳細(xì)了,但是為了體驗(yàn)Apifox更為強(qiáng)大的功能,我們有時(shí)候還是需要編輯下接口信息的。
接口設(shè)計(jì)
- 看下Apifox的請(qǐng)求參數(shù)界面,非常詳細(xì)!
- 再看下Apifox返回結(jié)果界面,支持折疊,這個(gè)很多工具都是沒(méi)有的;
- 再看下Apifox的
修改文檔
界面,支持添加狀態(tài)、分組和標(biāo)簽。
接口調(diào)試
我們?cè)賮?lái)體驗(yàn)下Apifox的調(diào)試功能,比Postman更強(qiáng)大!
- 在我們開(kāi)發(fā)接口時(shí),很多時(shí)候需要分不同的環(huán)境,Apifox默認(rèn)給我們分了
測(cè)試環(huán)境
、正式環(huán)境
、Mock服務(wù)
,這三個(gè)基本也夠用了;
- 在調(diào)試接口之前,我們得先設(shè)置好環(huán)境所對(duì)應(yīng)的
前置URL
,比如這里我們?cè)O(shè)置了測(cè)試環(huán)境
的;
- 在Apifox中我們可以使用
接口用例
來(lái)調(diào)試我們的接口,接口用例可以保存我們輸入的參數(shù),以便之后測(cè)試使用;
- Apifox支持在接口調(diào)用前后做自定義操作,比如我們可以在
后置操作
中添加一個(gè)斷言
,返回結(jié)果中code等于200
表示操作成功;
- 此時(shí)我們輸錯(cuò)密碼來(lái)調(diào)用下接口,斷言會(huì)直接提示我們結(jié)果和預(yù)期不符合;
- 有些接口我們需要傳入
Authorization
頭才能訪問(wèn);
- 這種訪問(wèn)我們可以通過(guò)
環(huán)境變量
來(lái)實(shí)現(xiàn),首先在登錄接口中添加后置操作
,選擇提取變量
,將返回的token提取到環(huán)境變量AUTH_TOKEN
中;
- 然后修改接口文檔,在
Header
中設(shè)置需要傳入Authorization
頭;
- 接下來(lái)在
接口用例
中通過(guò)表達(dá)式使用Authorization
頭即可正常訪問(wèn)需要登錄認(rèn)證的接口了。
使用腳本
Apifox的自定義
前置操作
和后置操作
非常強(qiáng)大,不僅支持簡(jiǎn)單的斷言
和提取變量
,還能支持編寫(xiě)JS腳本。
- 例如之前我們判斷操作成功,斷言
code等于200
可以使用腳本這樣實(shí)現(xiàn);
- 此時(shí)我們輸錯(cuò)密碼來(lái)調(diào)用下接口,斷言會(huì)直接提示我們結(jié)果和預(yù)期不符合。
Mock數(shù)據(jù)
在我們后端接口沒(méi)有開(kāi)發(fā)完成,前端開(kāi)發(fā)需要數(shù)據(jù)時(shí),往往可以通過(guò)Mock來(lái)提供數(shù)據(jù),Apifox的Mock數(shù)據(jù)功能也是很強(qiáng)大的。
- Apifox號(hào)稱能根據(jù)你數(shù)據(jù)模型中的字段名稱
智能Mock
,讓我們來(lái)看看它的規(guī)則;
- 其實(shí)默認(rèn)的Mock規(guī)則有時(shí)候并不是很完善,比如我們來(lái)看下它Mock的數(shù)據(jù);
- 此時(shí)我們可以在
數(shù)據(jù)模型
中修改,可以讓Mock的數(shù)據(jù)更加人性化一點(diǎn),比如我們可以將各種狀態(tài)設(shè)置為枚舉類型;
- 還可以將logo字段通過(guò)
@image
這種方式設(shè)置為圖片類型;
- 重新設(shè)置一下之后,人性化多了;
- 接下來(lái)只需把環(huán)境改為
Mock服務(wù)
就可以調(diào)用Mock數(shù)據(jù)的接口了!
測(cè)試管理
Apifox不僅能支持接口調(diào)試,還支持創(chuàng)建測(cè)試用例進(jìn)行批量測(cè)試以及性能測(cè)試。
- 首先我們可以在
測(cè)試管理
中創(chuàng)建測(cè)試用例;
- 之后選擇
從接口用例導(dǎo)入
,選擇好需要導(dǎo)入的接口用例;
- 選擇好
運(yùn)行環(huán)境
后,點(diǎn)擊運(yùn)行進(jìn)行批量測(cè)試;
- 測(cè)試完成后即可顯示測(cè)試報(bào)告;
- 如果你想進(jìn)行性能測(cè)試的話,在測(cè)試界面選擇好
線程數(shù)
即可;
- 測(cè)試完成后,可以通過(guò)
導(dǎo)出報(bào)告
來(lái)查看更為詳細(xì)的報(bào)告信息。
主題設(shè)置
個(gè)人比較習(xí)慣暗色
主題,Apifox也是可以選擇亮色
主題和主色的,直接在設(shè)置中可以進(jìn)行切換。文章來(lái)源:http://www.zghlxwxcb.cn/news/detail-783647.html
總結(jié)
Apifox確實(shí)是一款界面漂亮、功能強(qiáng)大的API接口工具。Postman有的接口調(diào)試功能它基本都有,還集成了接口文檔管理、數(shù)據(jù)Mock、自動(dòng)化測(cè)試等功能,強(qiáng)烈建議大家嘗試下!文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-783647.html
到了這里,關(guān)于接口測(cè)試神器——Apifox從安裝到使用的詳細(xì)教程的文章就介紹完了。如果您還想了解更多內(nèi)容,請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!