什么是API測(cè)試
什么是API
關(guān)于定義什么的缕坎,直接維基可得:
API(Application Programming Interface污呼,簡(jiǎn)稱:API)项郊,又稱為應(yīng)用編程接口偏化,就是軟件系統(tǒng)不同組成部分銜接的約定嗅绰。由于近年來(lái)軟件的規(guī)模日益龐大,常常需要把復(fù)雜的系統(tǒng)劃分成小的組成部分向族,編程接口的設(shè)計(jì)十分重要呵燕。程序設(shè)計(jì)的實(shí)踐中,編程接口的設(shè)計(jì)首先要使軟件系統(tǒng)的職責(zé)得到合理劃分炸枣。良好的接口設(shè)計(jì)可以降低系統(tǒng)各部分的相互依賴虏等,提高組成單元的內(nèi)聚性,降低組成單元間的耦合程度适肠,從而提高系統(tǒng)的維護(hù)性和擴(kuò)展性霍衫。
換句話說(shuō),API也可以看做程序/資源/組件的集成點(diǎn)侯养。它的功能會(huì)跟UI有些類似敦跌,通過(guò)某些特定指令、參數(shù)等可以讓后臺(tái)的一堆代碼運(yùn)行起來(lái)逛揩,最后得到想要的結(jié)果柠傍。不同的是它不提供可視的按鈕文本框之類的界面,而通常是由一個(gè)直接和底層代碼打交道的鏈接構(gòu)成辩稽。
什么是API功能測(cè)試
API測(cè)試是針對(duì)系統(tǒng)所提供的API做各方面的驗(yàn)證惧笛。API的性能和安全測(cè)試根據(jù)測(cè)試策略的不同,會(huì)是一個(gè)可選測(cè)試項(xiàng)逞泄。這個(gè)可以作為兩個(gè)單獨(dú)的問(wèn)題來(lái)討論患整。
API的功能測(cè)試類似于UI功能測(cè)試,都是在已知輸入內(nèi)容和期望結(jié)果的前提下喷众,使用這個(gè)功能/調(diào)用這個(gè)API并且驗(yàn)證是否能返回期望的結(jié)果各谚。不同的是API測(cè)試在返回結(jié)果被呈現(xiàn)給客戶前就完成了,從而對(duì)測(cè)試環(huán)境的依賴會(huì)比較小到千。
為什么要做API功能測(cè)試
測(cè)試金字塔
在討論這個(gè)話題之前昌渤,我們先來(lái)回顧下測(cè)試金字塔:
如圖所示。簡(jiǎn)單來(lái)講就是說(shuō)越往上層走的測(cè)試憔四,需要投入的成本會(huì)越高膀息,而且會(huì)越難以維護(hù)。在這個(gè)結(jié)構(gòu)下了赵,因?yàn)閁T已經(jīng)覆蓋了絕大部分的代碼潜支,所以其上層的集成/API測(cè)試和UI測(cè)試可以去除重復(fù)測(cè)試的部分,從而量也會(huì)越來(lái)越少斟览,并且會(huì)有不錯(cuò)的覆蓋率。
所以理想中的自動(dòng)化測(cè)試結(jié)構(gòu)應(yīng)該是大量的UT+適量的集成測(cè)試(或者API測(cè)試)+少量的UI測(cè)試辑奈。
構(gòu)建API測(cè)試的價(jià)值
測(cè)試覆蓋率苛茂。UT關(guān)注點(diǎn)是各個(gè)單元是否能夠完成期望工作已烤,只覆蓋一個(gè)單元內(nèi)部工作情況;集成/API測(cè)試關(guān)注點(diǎn)是各個(gè)模塊/單元之間協(xié)同工作妓羊,它所覆蓋的場(chǎng)景也會(huì)比單元測(cè)試更多胯究。而UI測(cè)試會(huì)更加關(guān)注e2e,模擬用戶行為躁绸,在所有的程序依賴環(huán)境準(zhǔn)備完成后再進(jìn)行操作裕循。相比之下API測(cè)試不依賴環(huán)境,測(cè)試成本會(huì)比UI測(cè)試更低净刮,而且覆蓋率比UT更高剥哑。
快速反饋。API測(cè)試速度比UI測(cè)試更快(因?yàn)闊o(wú)需界面加載/響應(yīng))淹父,短時(shí)間內(nèi)能跑很多用例株婴。API測(cè)試也能精確的揭露是軟件中哪個(gè)組件除了問(wèn)題,如果把你的API測(cè)試放到CI里面暑认,一旦代碼修改破壞了現(xiàn)有的功能困介,就能夠快速反饋到團(tuán)隊(duì)中。還可以把測(cè)試中發(fā)現(xiàn)的BUG也寫到API測(cè)試?yán)锩嬲杭剩寽y(cè)試成為一堵墻座哩,從而能更好的能保證產(chǎn)品質(zhì)量。
可復(fù)用粮彤。API測(cè)試由于不需要瀏覽器根穷、GUI等環(huán)境,所以可以更加靈活的在各個(gè)環(huán)境中復(fù)用驾诈。例如你可以在產(chǎn)品環(huán)境中、測(cè)試環(huán)境茬射、研發(fā)環(huán)境中使用闸迷,你需要做的只是修改下測(cè)試數(shù)據(jù)而已。另外如果是在TDD模式下工作的話闯两,API測(cè)試可能會(huì)在產(chǎn)品完成前就寫完了褥伴,后續(xù)的工作也會(huì)減少很多。
怎么做API功能測(cè)試
API功能測(cè)試的主要手段是使用工具/軟件調(diào)用待測(cè)API漾狼,然后驗(yàn)證是否返回期望的output重慢。這個(gè)output通常可能是:
* 返回成功或者失敗的status
* 是一段數(shù)據(jù)或者information
* 或者是跳轉(zhuǎn)到其他API
工具
市面上常見(jiàn)的API測(cè)試工具我知道的可以分成幾大類:
- 開源純代碼類逊躁,比如基于nodeJS的supertest似踱,基于Java的rest-assured等,這類工具易于學(xué)習(xí),易于和CI集成核芽,但是需要使用者有一定的編碼能力囚戚。
- 商用工具,比如SoapUI轧简,功能強(qiáng)大操作簡(jiǎn)單驰坊,還提供免費(fèi)社區(qū)辦可以試用。
- 各類插件工具哮独,比如Chrome插件Postman拳芙,也有收費(fèi)版可以玩兒。
工具的選擇見(jiàn)仁見(jiàn)智皮璧,根據(jù)不同的環(huán)境選擇不同的工具舟扎。
測(cè)試
在正式開始測(cè)試之前,你得先搞清楚幾個(gè)問(wèn)題:
- 待測(cè)API的目的是什么恶导,誰(shuí)是使用者
- 待測(cè)API會(huì)在什么環(huán)境下使用
- 待測(cè)API在異常環(huán)境下會(huì)不會(huì)有非期望響應(yīng)
- 這個(gè)測(cè)試需要測(cè)什么功能點(diǎn)
- 各個(gè)功能點(diǎn)的測(cè)試優(yōu)先級(jí)
- 如何定義期望返回的結(jié)果是成功還是失敗
- 待測(cè)API會(huì)不會(huì)和其他系統(tǒng)有交互(修改代碼后影響其他系統(tǒng))
這些問(wèn)題會(huì)影響到你的測(cè)試結(jié)果是否符合客戶需求浆竭,或者說(shuō)這些潛在的風(fēng)險(xiǎn)會(huì)影響到這個(gè)項(xiàng)目是否成功。
如果你選的是必須得自己寫點(diǎn)兒代碼的工具惨寿,那么接下來(lái)得根據(jù)選擇的工具和項(xiàng)目代碼邦泄,去setup測(cè)試環(huán)境,讓工具能夠成功跑起來(lái)裂垦。
接著是設(shè)計(jì)你的測(cè)試框架顺囊,最好是要滿足可復(fù)用性強(qiáng),高內(nèi)聚低內(nèi)聚什么的原則蕉拢,記得要有輸出測(cè)試報(bào)告的模塊特碳。
然后是用例,上面你已經(jīng)想好了需要測(cè)哪些功能點(diǎn)晕换,針對(duì)這些點(diǎn)我們用腦圖之類的工具把需要測(cè)試的場(chǎng)景記錄下來(lái)午乓。
最后就是腳本設(shè)計(jì)和測(cè)試數(shù)據(jù)設(shè)計(jì),腳本和數(shù)據(jù)最好可以分開闸准,這樣的話可以復(fù)用測(cè)試腳本益愈,用不同的測(cè)試數(shù)據(jù)輸入去獲取不同的期望結(jié)果。
驗(yàn)證的過(guò)程大致包含下面這些:
- 檢查API是不是根據(jù)你輸入的數(shù)據(jù)返回期望的結(jié)果
- 驗(yàn)證API是不是不返回結(jié)果或者返回異常結(jié)果
- 驗(yàn)證API是不是正確觸發(fā)其他event或者正確調(diào)了其他API
- 驗(yàn)證API是不是正確更新了數(shù)據(jù)等等
完了就是輸出測(cè)試報(bào)告了夷家,好的測(cè)試報(bào)告可以幫助你輕松定位到出錯(cuò)的地方蒸其,使修復(fù)流程更加順暢。
最后的最后库快,強(qiáng)烈推薦把測(cè)試集成到CI中去摸袁,加速異常反饋,創(chuàng)建墻有力的質(zhì)量體系义屏。