接口

接口概述

定義：接口就是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ù)字，以及用戶的操作請(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)用開發(fā)者來(lái)說(shuō)榨汤，有了開放的API，就可以直接調(diào)用多家公司做好的功能來(lái)做自己的應(yīng)用怎茫，不需要所有的事情都自己操刀收壕，節(jié)省精力。

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

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

采用的協(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ù)陌踩怨┏！Ｎ覀兤匠４蜷_兩頁(yè)的時(shí)候會(huì)看到網(wǎng)址前面都有一個(gè)HTTP或HTTPS摊聋，這就是告訴你，你在向服務(wù)器發(fā)送此請(qǐng)求的過(guò)程中要遵循的協(xié)議是HTTP或HTTPS (也就是規(guī)則)栈暇。

服務(wù)器地址(//www.qubaobei.com)：以雙斜杠“//”開頭麻裁，后面跟的就是這個(gè)服務(wù)器的地址，專業(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)容，和路徑之間使用“?”隔開香缺，參數(shù)之間使用“&”隔開手销。參數(shù)是以鍵值對(duì)的形式表現(xiàn)出來(lái)的。

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

接口文檔

接口文檔展示

封皮

封面最好是本公司規(guī)定的封面馏慨，有l(wèi)ogo，內(nèi)容標(biāo)題姑隅，版本號(hào)，公司名稱倔撞，文檔產(chǎn)生

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

修訂歷史

表格形式較好些痪蝇。包括：

版本鄙陡，修訂說(shuō)明，修訂日期躏啰，修訂人趁矾，審核時(shí)間，審核人给僵。

接口信息

接口調(diào)用方式毫捣，是post方式還是get方式，接口地址帝际，別人需要線上的哪個(gè)地址就寫哪個(gè)蔓同。（自己提前測(cè)試好線上的這個(gè)接口，是否有其他問(wèn)題蹲诀，千萬(wàn)別犯低級(jí)的錯(cuò)誤斑粱，尤其是某個(gè)字母寫錯(cuò)）

功能描述

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

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

每個(gè)參數(shù)都要和實(shí)際中調(diào)用的一樣，包括大小寫痕慢；參數(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ù)恭取，一定要注意寫清晰。

返回值說(shuō)明

1熄守、有一個(gè)模板返回值蜈垮，并說(shuō)明每個(gè)返回參數(shù)的意義耗跛。

2、提供一個(gè)真實(shí)的調(diào)用接口攒发，真實(shí)的返回值调塌。

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

接口測(cè)試的概念

概念

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

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

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

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

目的

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

原理

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

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

典型商業(yè)工具：

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

SoapUI：開源測(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)不用了蟹倾。

典型開源工具

Jmeter ：一款開源的接口測(cè)試工具匣缘，操作簡(jiǎn)單，方便鲜棠，既有jdbc request操作數(shù)據(jù)庫(kù)數(shù)據(jù)肌厨，也有http request和soap request應(yīng)對(duì)測(cè)試

擴(kuò)展插件

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

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

單一接口

單一接口功能的測(cè)試主要測(cè)試返回的數(shù)據(jù)結(jié)構(gòu)是否和接口文檔給出的一致表鳍，接口的正常功能是否完成馅而，接口的參數(shù)檢查測(cè)試，接口的異常測(cè)試譬圣。

組合接口

定義：組合接口測(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)物車 --> 提交訂單 -->支付

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

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

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

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

（2）字段名稱是否正確等

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

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

功能邏輯

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

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

異常測(cè)試

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

路徑測(cè)試

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

其他異常場(chǎng)景

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

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

測(cè)試案例

get請(qǐng)求

post請(qǐng)求

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