API測試(或WebService測試)在軟件測試中變得越來越重要。根據谷歌趨勢報告,過去五年來,行業內對API測試的興趣一直在增加。這種趨勢在一定程度上表明API測試的需求變得更加普遍。測試API或WebService不再僅僅由原來的開發人員執行,在獨立的測試團隊中,也是非常常見的一部分工作了。
本教程將演示如何快捷的使用Katalon Studio從頭開始創建一個API / WebService測試(以下簡稱為API測試)。
在開始進行API測試之前,我們需要先了解一些關于Katalon Studio中關于API測試對象的基本術語。
Test Case:
這是Katalon Studio項目結構中最重要的概念之一,測試用例集合中列出了用戶存儲的所有測試用例。
Object Repository:
測試對象庫是用來存儲所有測試對象的。
????在UI測試中,測試對象是具有指定定位器的Web元素,Web Driver在測試執行期間使用這些定位器來定位Web元素。
????在API 測試中,測試對象指的是具有URL(域名或IP地址)和一些必要信息(如methods, authorization, body, parameters等)的請求函數,測試執行期間rest-client會使用這些信息去發送請求。
Request:
在API 測試時,Request指的是客戶端向服務端的一次請求。
在一個Request中,URL和method是必需的信息,而authorization, body和 parameters是可選的,并且取決于請求類型。
在Katalon Studio中,請求存儲在Object Repository中,可以從任何測試用例的步驟中調用。
Response:
一個響應,就是服務端對客戶端請求返回的數據。典型的響應包含Headers,Body以及Code(響應代碼)等信息。
在Katalon Studio中,響應存儲在Object Repository(請求級別)或任何測試用例的步驟中。目前,可以在每個單獨的測試用例中驗證響應。
使用Katalon Studio從頭開始創建API測試用例
第1步:創建一個Request
右鍵單擊Object Repository,在New子菜單下選擇Web Service Request,打開Web Service Request對話框。
將信息輸入到新的“?Web Service Request”對話框中
Name:?請求名稱,用于指定請求的名稱。沒有特殊的命名規則。但是強烈建議定義的名稱是可讀的,最好能夠表達出請求的目的。
Request Type:?請求類型,在Katalon Studio中,Web服務請求可以是RESTful或SOAP。由于RESTful變得越來越流行,因此在對話框中默認選擇它。
URL:?請求的具體地址
Description:?如果需要,可以填寫有關請求的更多備注信息。
填寫完成所有信息后,將在單擊“OK”按鈕,就創建了一個Request。
第2步:設置Request
(1)第一步中創建的Request。
(2)請求的方法,如果請求類型是RESTful,則可以選擇以下方法之一:GET,PUT,POST,DELETE。
(3)請求的URL,可以在創建請求后隨時更新。
(4)授權設置,用于配置連接服務端的授權。Basic和OAuth 1.0是兩種最常見的授權方法。
????Basic: 需要設置有效的用戶名和密碼
????OAuth 1.0: 需要設置表單中要求的所有配置
? ??注意:授權設置完成后,需單擊“Update to HTTP Header”,使配置生效。
(5)?HTTP Header配置。
(6)組織用例集的文件夾結構。
????被測應用程序通常有數百種服務,因此擁有良好的組織非常重要。在Katalon Studio中,強烈建議使用文件夾結構按路徑、功能和方法對Web服務進行分組。
第3步:Smoke(冒煙測試)
點擊發送按鈕,即可發送請求并快速驗證響應。
(1)發送按鈕,單擊發送請求。
(2)Status: 請求的響應代碼。代碼反映了請求的狀態,詳細了解響應代碼。
(3)Elapsed: 從請求到獲取響應所需的時間。
(4)Size: 響應數據的大小。
(5)Body / Header: 響應數據的Body和Header信息。
(6)顯示格式,Katalon Studio將自動選擇漂亮模式以正確格式顯示數據。目前,它支持JSON,XML,HTML,JavaScript數據類型。
步驟4:創建測試用例
前3個步驟演示了如何在Object Repository創建Request并進行冒煙測試,此步驟將帶你創建一個測試用例。
(1)創建一個具有可讀名稱的測試用例。強烈建議測試用例名稱簡要描述測試場景(測試目的)。
(2)從測試用例編輯器中,選擇“Add - > Web Service Keyword”,添加新步驟。
(1)在項目下拉列表中,選擇“Send Request”關鍵字
(2)單擊同一行中的Object cell打開“Test Object Input”對話框
(3)從“Object Type”列表中選擇“Test Object”
(4)選擇我們前面創建的Request
第5步:添加驗證步驟
此步驟將指導你如何將驗證添加到測試用例中。
(1)?上一步中已經添加的Request。
(2)為了驗證請求返回的內容,我們需要指定請求的輸出。只需在Output中輸入稍后使用的變量名稱即可,例如response。
(3)測試用例的步驟2和步驟3用于驗證。與“Send Request”類似的方式添加。步驟2驗證響應代碼(如果請求成功發送,則為200)。
(4)驗證響應代碼是否為200。
(5)使用jsonpath和期望值驗證響應內容。
第6步:執行測試用例
執行API測試用例與執行UI功能測試用例完全相同。但是,在API測試中,不會使用到瀏覽器。
恭喜!通過以上6個簡單的步驟,現在已經成功地從零開始創建了一個簡單的API測試。
即刻開始你的Katalon之旅吧。
Notes:
Source code:https://github.com/katalon-studio-samples/jira-api-tests
Project: Jira API
詳情查閱官方原文,搬運過程中若詞句有不當之處,還望見諒。