yapi平臺(tái)基本使用介紹

主界面介紹

image.png

分組管理菜單

1、項(xiàng)目列表

展示分組內(nèi)自己所在的項(xiàng)目,點(diǎn)擊進(jìn)入項(xiàng)目詳情

2、成員列表

展示和管理分組內(nèi)的人員構(gòu)成


image.png

1.添加成員
2.更改成員權(quán)限
3.刪除成員

3、分組動(dòng)態(tài)

展示分組內(nèi)的項(xiàng)目接口動(dòng)態(tài)


image.png

4、分組設(shè)置

image.png

自定義分組信息

項(xiàng)目

1、接口

1.1 接口列表

image.png

添加分類(lèi),生成新的接口集合
在分類(lèi)中添加接口,新增簡(jiǎn)單接口信息

1.2 接口詳情

1.2.1 預(yù)覽

點(diǎn)擊某個(gè)接口,進(jìn)入接口詳情--預(yù)覽


image.png

展示詳細(xì)的接口信息,包括基本信息,請(qǐng)求參數(shù),返回?cái)?shù)據(jù)等

1.2.2 編輯

點(diǎn)擊頂部“編輯”,進(jìn)入編輯模式

基本設(shè)置

接口的基本信息及路徑
接口url中有參數(shù)的,可以用{}標(biāo)識(shí)


image.png
請(qǐng)求參數(shù)設(shè)置

1.參數(shù)類(lèi)型可以選擇 body,query以及headers
2.body參數(shù)可以選擇對(duì)應(yīng)類(lèi)型
3.選擇form格式可以批量添加參數(shù)
4.選擇json格式可以直接導(dǎo)入,系統(tǒng)會(huì)進(jìn)行格式校驗(yàn),通過(guò)后會(huì)自動(dòng)解析并填充在下方


image.png
返回?cái)?shù)據(jù)設(shè)置

1.返回?cái)?shù)據(jù)為接口期望的返回結(jié)果,也可以已json格式或者raw格式填寫(xiě)
2.選擇json格式可以直接導(dǎo)入,系統(tǒng)會(huì)進(jìn)行格式校驗(yàn),通過(guò)后會(huì)自動(dòng)解析并填充在下方


image.png

1.2.3 運(yùn)行

image.png

發(fā)送--請(qǐng)求此接口
保存--將此接口及請(qǐng)求數(shù)據(jù)保存至測(cè)試合集


image.png

1.2.4 高級(jí)mock

可以自定義接口返回,設(shè)置過(guò)濾條件,滿(mǎn)足過(guò)濾條件時(shí),請(qǐng)求的接口返回則為自定義的返回


image.png
image.png

此處設(shè)置一個(gè)期望,打開(kāi)postman,請(qǐng)求對(duì)應(yīng)的mock地址
參數(shù)滿(mǎn)足過(guò)濾條件,則請(qǐng)求返回為自定義結(jié)果


image.png

1.3 測(cè)試合集

后續(xù)更新自動(dòng)化實(shí)施詳細(xì)講解

2、動(dòng)態(tài)

image.png

api更新修改后,此處可以查看修改記錄及修改內(nèi)容
點(diǎn)擊改動(dòng)詳情,可查看接口的具體改動(dòng)內(nèi)容。紅色表示刪除的內(nèi)容,綠色表示新增的內(nèi)容。


image.png

3、數(shù)據(jù)管理--快速導(dǎo)入導(dǎo)出標(biāo)準(zhǔn)化接口

image.png

3.1-導(dǎo)入

點(diǎn)擊彈出下拉框,可選擇自己需要的模式
導(dǎo)入成功后,導(dǎo)入的接口會(huì)在接口列表中展示

3.2-導(dǎo)出

image.png

可將平臺(tái)中已有的接口數(shù)據(jù)導(dǎo)出,導(dǎo)出后的文件可以作為數(shù)據(jù)源再次在其他項(xiàng)目導(dǎo)入。
可以解決項(xiàng)目遷移的問(wèn)題

4、成員管理

對(duì)項(xiàng)目所屬成員進(jìn)行增加,刪除,修改權(quán)限等操作

5、設(shè)置

image.png

5.1 項(xiàng)目配置

項(xiàng)目基本信息

5.2 環(huán)境配置

1、項(xiàng)目環(huán)境管理,可以配置多個(gè)不同的環(huán)境,在測(cè)試接口或者進(jìn)行自動(dòng)化測(cè)試時(shí)可以按需選擇對(duì)應(yīng)的環(huán)境
2、環(huán)境可以增加,可以刪除
3、每個(gè)環(huán)境可以單獨(dú)設(shè)置域名,請(qǐng)求頭,全局變量等個(gè)性化數(shù)據(jù),以滿(mǎn)足測(cè)試的多樣性


image.png

5.3 請(qǐng)求配置

可以自定義腳本,分為請(qǐng)求前和請(qǐng)求后的處理。請(qǐng)求前處理腳本,會(huì)在接口請(qǐng)求開(kāi)始前執(zhí)行,請(qǐng)求后處理腳本,會(huì)在請(qǐng)求完成后執(zhí)行


image.png

5.4 token配置

生成唯一項(xiàng)目標(biāo)識(shí),可以作為請(qǐng)求yapi項(xiàng)目openapi的憑證
非可視化界面操作,yapi提供了部分常用的openapi。
如:進(jìn)行自動(dòng)化測(cè)試,定期進(jìn)行接口同步,進(jìn)行數(shù)據(jù)導(dǎo)入等等

5.5 全局mock腳本--未研究

5.6 生成ts services 未研究

5.7 swagger自動(dòng)同步

可以選擇時(shí)間,選擇周期,選擇同步方式,定期自動(dòng)執(zhí)行接口同步,保證yapi平臺(tái)中接口為最新接口,不需要人工維護(hù)


6、wiki

無(wú)特殊功能,可以作為一個(gè)記事本,記錄項(xiàng)目關(guān)聯(lián)信息

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容