11.1 接口

11.1.1 接口概述

定義：接口就是API（Application Programming Interface褐健，應(yīng)用程序接口）碍论，是一個(gè)軟件或服務(wù)對(duì)外提供的接口，別人只要調(diào)用這接口，而內(nèi)部如何實(shí)現(xiàn)，不需要關(guān)心明刷。你只要按照要求進(jìn)行接口調(diào)用即可。

外部系統(tǒng)與系統(tǒng)之間以及內(nèi)部各子系統(tǒng)之間的交互點(diǎn)满粗。包括外部接口辈末、內(nèi)部接口。

舉例：

假設(shè)物流中“貨物”是數(shù)據(jù)映皆，存放貨物的“總倉(cāng)庫(kù)”是數(shù)據(jù)庫(kù)挤聘，“店鋪”是我們的網(wǎng)站、App捅彻。頁(yè)面上顯示的內(nèi)容组去、數(shù)字，以及用戶(hù)的操作請(qǐng)求和結(jié)果都是需要不停搬運(yùn)的“貨物”——數(shù)據(jù)步淹，則負(fù)責(zé)調(diào)配分配打包的中轉(zhuǎn)站就是API遥倦，快遞小哥直接從中轉(zhuǎn)站取貨就好叹括。

作用：對(duì)于軟件提供商來(lái)說(shuō)饲漾，留出API褒傅，讓別的應(yīng)用程序來(lái)調(diào)用桐臊，軟件才能發(fā)揮最大的價(jià)值纫版，才能更有生命力汇鞭。（同時(shí)別人也看不見(jiàn)代碼耘沼，不傷害商業(yè)機(jī)密韧衣。）

對(duì)于應(yīng)用開(kāi)發(fā)者來(lái)說(shuō)盅藻，有了開(kāi)放的API，就可以直接調(diào)用多家公司做好的功能來(lái)做自己的應(yīng)用畅铭，不需要所有的事情都自己操刀氏淑，節(jié)省精力。

11.1.2 接口的表現(xiàn)形式

客戶(hù)端要先操作服務(wù)端資源硕噩，首先要找到服務(wù)端提供的接口假残，然后才能向服務(wù)端發(fā)送資源請(qǐng)求，那么何為服務(wù)端接口呢？其實(shí)就是一個(gè)地址（URL）辉懒，比如：

http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1

1615302590(1).png

采用的協(xié)議(http:)：一般來(lái)講網(wǎng)址中第一個(gè)“:”前面的就是該網(wǎng)址所采用的協(xié)議阳惹。這里的HTTP就是個(gè)協(xié)議 。HTTPS是HTTP的安全版本眶俩，HTTPS在HTTP的基礎(chǔ)對(duì)傳輸?shù)臄?shù)據(jù)進(jìn)行了加密和簽名莹汤，以保證數(shù)據(jù)傳輸?shù)陌踩浴Ｎ覀兤匠４蜷_(kāi)兩頁(yè)的時(shí)候會(huì)看到網(wǎng)址前面都有一個(gè)HTTP或HTTPS颠印，這就是告訴你纲岭，你在向服務(wù)器發(fā)送此請(qǐng)求的過(guò)程中要遵循的協(xié)議是HTTP或HTTPS (也就是規(guī)則)。

服務(wù)器地址(//www.qubaobei.com)：以雙斜杠“//”開(kāi)頭线罕，后面跟的就是這個(gè)服務(wù)器的地址止潮，專(zhuān)業(yè)術(shù)語(yǔ)叫域名。

請(qǐng)求資源路徑(/ios/cf/dish_list.php) ：表示你要請(qǐng)求的資源在該服務(wù)器下/ios/cf/dish_list.php的路徑下钞楼。

參數(shù)（?stage_id=1&limit=20&page=1）：參數(shù)可以找到具體內(nèi)容喇闸，和路徑之間使用“?”隔開(kāi)，參數(shù)之間使用“&”隔開(kāi)窿凤。參數(shù)是以鍵值對(duì)的形式表現(xiàn)出來(lái)的仅偎。

把此URLhttp://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1稱(chēng)為食品模塊個(gè)接口， 也稱(chēng)為接口地址雳殊。

11.2 接口文檔

接口文檔展示

11.2.1 封皮

封面最好是本公司規(guī)定的封面橘沥，有l(wèi)ogo，內(nèi)容標(biāo)題夯秃，版本號(hào)座咆，公司名稱(chēng)，文檔產(chǎn)生

日期仓洼。（錯(cuò)誤地方在于介陶，文檔的標(biāo)題要和頁(yè)眉中的標(biāo)題一致）

11.2.2 修訂歷史

表格形式較好些。包括：

版本色建，修訂說(shuō)明哺呜，修訂日期，修訂人箕戳，審核時(shí)間某残，審核人。

11.2.3 接口信息

接口調(diào)用方式陵吸，是post方式還是get方式玻墅，接口地址，別人需要線上的哪個(gè)地址就寫(xiě)哪個(gè)壮虫。（自己提前測(cè)試好線上的這個(gè)接口澳厢，是否有其他問(wèn)題，千萬(wàn)別犯低級(jí)的錯(cuò)誤，尤其是某個(gè)字母寫(xiě)錯(cuò)）

11.2.4 功能描述

一定要清晰的描述接口功能剩拢。（不要遺漏一些細(xì)節(jié)线得，比如接口獲取的信息不包括哪些，哪些要寫(xiě)明白）

11.2.5 接口參數(shù)說(shuō)明

每個(gè)參數(shù)都要和實(shí)際中調(diào)用的一樣裸扶，包括大小寫(xiě)框都；參數(shù)的含義言簡(jiǎn)意賅的說(shuō)明；格式是string 還是int 還是long等格式（例如參數(shù)為@RequestParam("appKey") StringappKey, @RequestParam("randomId") Integer randomId）呵晨；說(shuō)明部分魏保，說(shuō)明參數(shù)值是需要哪個(gè)公司提供，并詳細(xì)說(shuō)明參數(shù)怎么生成的摸屠，例如時(shí)間戳谓罗，是哪個(gè)時(shí)間段的；參數(shù)是否必填季二，一些參數(shù)是必須要有的檩咱，有些是可選參數(shù)，一定要注意寫(xiě)清晰胯舷。

11.2.6 返回值說(shuō)明

1刻蚯、有一個(gè)模板返回值，并說(shuō)明每個(gè)返回參數(shù)的意義桑嘶。

2炊汹、提供一個(gè)真實(shí)的調(diào)用接口，真實(shí)的返回值逃顶。

注：現(xiàn)實(shí)工作中讨便，對(duì)接口有疑問(wèn)要及時(shí)跟同事交流。

11.3 接口測(cè)試的概念

11.3.1 概念

測(cè)試系統(tǒng)組件間接口的一種測(cè)試以政。接口測(cè)試主要用于檢測(cè)外部系統(tǒng)與系統(tǒng)之間以及內(nèi)部各個(gè)子系統(tǒng)之間的交互點(diǎn)霸褒。

11.3.2? 接口測(cè)試本質(zhì)

實(shí)質(zhì)就是數(shù)據(jù)的傳輸和接受，傳輸?shù)氖墙涌诘刂分械膮?shù)盈蛮，接受的是文本字符串废菱，然后對(duì)比文本字符串是否正確。

11.4 接口測(cè)試的目的和原理

11.4.1 目的

測(cè)試接口的正確性和穩(wěn)定性抖誉。

11.4.2 原理

接口測(cè)試的原理是通過(guò)測(cè)試程序模擬客戶(hù)端向服務(wù)器發(fā)送請(qǐng)求報(bào)文殊轴，服務(wù)器接收請(qǐng)求報(bào)文后對(duì)相應(yīng)的報(bào)文做出處理然后再把應(yīng)答報(bào)文發(fā)送給客戶(hù)端，客戶(hù)端接收應(yīng)答報(bào)文這一個(gè)過(guò)程寸五。

11.5 常用接口測(cè)試工具

11.5.1 典型商業(yè)工具：

LoadRunner（LR）：一款商業(yè)性能測(cè)試工具梳凛，用來(lái)做接口測(cè)試耿币，很好很強(qiáng)大 梳杏，但是配置比較麻煩。

SoapUI：開(kāi)源測(cè)試工具，通過(guò)soap/http來(lái)檢查十性、調(diào)用叛溢、實(shí)現(xiàn)Web Service的功能/負(fù)載/符合性測(cè)試；該工具既可作為一個(gè)單獨(dú)的接口測(cè)試工具使用劲适，也可利用插件集成到Eclipse楷掉，maven2.X，Netbeans 和intellij中使用霞势。? ? 了解就可以了烹植，基本已經(jīng)不用了。

11.5.2 典型開(kāi)源工具

Jmeter ：一款開(kāi)源的接口測(cè)試工具愕贡，操作簡(jiǎn)單草雕，方便，既有jdbc request操作數(shù)據(jù)庫(kù)數(shù)據(jù)固以，也有http request和soap request應(yīng)對(duì)測(cè)試

13.5.3 擴(kuò)展插件

postman：谷歌瀏覽器的擴(kuò)展工具墩虹，主要用來(lái)做接口測(cè)試，谷歌商店中選中安裝憨琳，界面同poster差別不大诫钓，界面簡(jiǎn)潔。

13.6 接口測(cè)試應(yīng)該測(cè)什么

13.6.1 單一接口

單一接口功能的測(cè)試主要測(cè)試返回的數(shù)據(jù)結(jié)構(gòu)是否和接口文檔給出的一致篙螟，接口的正常功能是否完成菌湃，接口的參數(shù)檢查測(cè)試，接口的異常測(cè)試闲擦。

13.6.2 組合接口

定義：組合接口測(cè)試主要是通過(guò)組合多個(gè)單一接口慢味，來(lái)測(cè)試一個(gè)業(yè)務(wù)場(chǎng)景

案例：測(cè)試購(gòu)物網(wǎng)站的一個(gè)下單的功能，那么因?yàn)樵谙聠沃斑€有一些流程墅冷，所以要測(cè)試一個(gè)場(chǎng)景纯路。

測(cè)試：搜索商品 --> 選中商品 --> 添加進(jìn)購(gòu)物車(chē) --> 提交訂單 -->支付

（提交訂單時(shí)還涉及到地址的選取等）

注：涉及到如果使用從cookie或者session在本例中的區(qū)別：如果使用cookie加入購(gòu)物車(chē)，那么換一臺(tái)電腦購(gòu)物車(chē)?yán)锏纳唐肪筒淮嬖诹四蓿绻褂玫氖莝ession驰唬，購(gòu)物車(chē)?yán)锩娴臇|西就一直存在，即：cookie是本機(jī)作用的腔彰，session不止于本機(jī)作用叫编。

13.6.3 結(jié)構(gòu)檢查

（1）檢查返回值的結(jié)構(gòu)是否正確，如是json類(lèi)型還是xml類(lèi)型的數(shù)據(jù)

（2）字段名稱(chēng)是否正確等

XML和JSON都使用結(jié)構(gòu)化方法來(lái)標(biāo)記數(shù)據(jù)

13.7 接口測(cè)試內(nèi)容

13.7.1 功能邏輯

通過(guò)查數(shù)據(jù)庫(kù)或緩存等驗(yàn)證數(shù)據(jù)是否處理正確霹抛。

通過(guò)其他輔助途徑進(jìn)行驗(yàn)證

13.7.2 異常測(cè)試

接口測(cè)試中主要測(cè)試接口正常邏輯搓逾，但僅邏輯測(cè)試不能保證數(shù)據(jù)的安全及程序接口在異常情況下的邏輯處理的正確性。

13.7.3 路徑測(cè)試

當(dāng)被測(cè)接口的實(shí)現(xiàn)方法中杯拐，判斷邏輯復(fù)雜分支多霞篡，且判斷中又調(diào)用了其他的接口世蔗，此時(shí)必須要進(jìn)行路徑覆蓋測(cè)試。

13.7.4 其他異常場(chǎng)景

研發(fā)的項(xiàng)目朗兵，有些項(xiàng)目是底層使用的系統(tǒng)污淋，根據(jù)項(xiàng)目特點(diǎn)，可能會(huì)存在特殊的異常場(chǎng)景余掖。

例如： 支付的異步操作寸爆，支付消息重試等

11.8 測(cè)試案例

11.8.1 get請(qǐng)求

11.8.2 post請(qǐng)求

13.9 接口測(cè)試用例模板

接口測(cè)試用例模板.png

接口測(cè)試用例模板

作者：Anwfly

鏈接：http://www.reibang.com/p/c14153a841c7

來(lái)源：簡(jiǎn)書(shū)

著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請(qǐng)聯(lián)系作者獲得授權(quán)盐欺，非商業(yè)轉(zhuǎn)載請(qǐng)注明出處赁豆。