RESTClient 使用

Wisdom RESTClient 一款自動化測試REST API的工具，它能夠自動化測試RESTful API並生成精美的測試報告，同時基於測試過的歷史API，能夠生成精美的RESTful API文檔。

1. 使用RESTClient前的準備工做

1.1 下載RESTClient

JAR包： restclient.jar；

1.2 使用前安裝Java

支持的Java版本 >=1.7

1.3 啓動RESTClient軟件

雙擊restclient.jar，或者執行命令java -jar restclient.jar啓動RESTClient軟件。

RESTClient主窗體包含：

• 請求視圖（Request）
• 響應視圖（Response）
• 歷史視圖（History）
• 菜單欄（File, Edit, Test, Apidoc, Help）

2. 使用RESTClient測試REST API步驟

2.1 請求視圖中輸入REST API所需的請求數據

在請求視圖中對所測試的REST API輸入的數據詳情以下：

2.1.1 選擇請求方法

RESTClient支持請求方法詳情以下：

方法名	操做	備註
GET	查詢	無須要填寫請求體
POST	添加
PUT	修改
DELETE	刪除	無須要填寫請求體

2.1.2 輸入訪問REST API的URL

• URL格式： HTTP協議://主機名:端口號/路徑

• URL示例： http://restclient.cn:8080/restapi

2.1.3 輸入請求體(Body)

若是選擇的請求方法是POST或者PUT則能夠填寫請求體，其餘方法則無需填寫。

2.1.3.1 選擇請求體類型（Body-Type）

• 字符串(String)

  直接在請求體的文本框中填寫字符串；

• 文件(File)

  瀏覽並選擇地文本文件，文件內容會被讀取並做爲請求體。

2.1.3.2 選擇內容類型（Content-Type）

根據REST API消息體類型，對照下表，選擇跟API匹配的內容類型，若是表中的內容類型都不是API所須要的類型，能夠直接在內容類型文本框中輸入所需類型。
常見的內容類型詳情以下：

內容類型（Content-Type）	數據格式
application/json	JSON
application/xml	XML
application/x-www-form-urlencoded	Form表單
text/plain	純文本
text/xml	XML文本
text/html	HTML文本
multipart/form-data	用於上傳文件
application/xhtml+xml	XHTML

2.1.4 選擇字符集(Charset）

默認字符集是UTF-8，能夠選擇REST API所須要的字符集，若是下拉列表裏的字符集都不是API所須要的，能夠直接在字符集文本框中輸入所需的字符集。

2.1.5 填寫消息頭(Header）

能夠根據REST API定義要求，以鍵值對的形式添加相應的消息頭。
Header鍵值對示例：

Key   ： Accept
Value ： application/json

2.1.6 填寫Cookie

能夠根據REST API定義要求，以鍵值對的形式添加相應的Cookie。
若是API須要登陸認證，請先使用瀏覽器完成API登陸認證成功後，將瀏覽器生成的JSESSIONID填寫到Cookie中，這樣就能夠無需登陸認證，直接訪問REST API了，免登錄使用詳情參考資料。
Cookie鍵值對示例：

Key   ：JSESSIONID 
Value : MY0REST1COOKIE2DEMO3

2.1.7 完整的請求數據示例

填寫完請求數據後點擊Start按鈕會觸發API請求，在請求視圖中輸入完整的請求數據如圖所示：

2.2 響應視圖中返回REST API響應的數據

REST API請求完成後獲得響應數據以下：

• 響應狀態碼（Status）
• 響應消息體（Body）
• 響應消息頭（Header）
• 原始的響應數據（Raw）

響應數據如圖所示：

2.3 歷史視圖中記錄測試過的REST API

在歷史視圖中能夠對API進行的可視化編輯以下：

• 刷新API
• 對選中的API進行順序調整
• 刪除選中的API或者清空所有歷史API
• 能夠編輯選中的API

歷史API可視化編輯的快捷菜單如圖所示：

2.4 對歷史REST API進行再測試

若是須要對歷史API進行再測試，在RESTClient菜單欄點擊 Test => Start Test

記錄的歷史API測試完成後，在Windows系統中會使用默認的瀏覽器打開測試報告。其餘系統能夠根據提示框中的報告路徑，手動打開測試報告。
測試報告如圖所示：

2.5 對歷史REST API生成API文檔

若是須要生成API文檔，在RESTClient菜單欄點擊 Apidoc => Create

API文檔生成完成後，在Windows系統中會使用默認的瀏覽器打開API文檔。其餘系統能夠根據提示框中的文檔路徑，手動打開API文檔。
API文檔如圖所示：

2.6 對歷史REST API進行編輯

爲了知足API再測試要求或者知足API文檔數據要求，能夠對API進行以下操做：

• 調整API順序
• 刪除冗餘的、廢棄的API
• 對API進行可視化編輯

歷史視圖中選中API，快捷菜單中選擇Edit打開API編輯窗體，如圖所示：

在API編輯窗體中，能夠編輯以下內容：

• 請求方法
• 請求URL
• 請求頭（Header）
• 請求體（Body）
• 響應狀態碼（Status）
• 響應的消息體（Text視圖）
• 是否校驗返回的消息體（Assert Body）

默認勾選了Assert Body，API再測試會對返回的消息體進行完整匹配校驗，若是不須要對返回的消息體進行匹配校驗，能夠去勾選。

若是返回的消息體中的某些JSON節點不須要進行再測試匹配校驗，能夠在Viewer視圖上勾選排除這些節點，這樣API再測試只對未排除的節點進行匹配校驗。

2.7 定製API文檔

若是生成的API文檔不能知足要求，須要改動，能夠修改數據文件work/apidoc/js/apidata.js來定製API文檔，API定製詳情能夠參考資料。

2.8 經過命令行（CLI）方式使用RESTClient實現自動化測試REST API

RESTClient支持經過執行命令的方式啓動和再測試API以及生成API文檔，RESTClient CLI使用詳情參考資料。

經過CLI方式，這樣很容易在Jenkins中定時執行命令來調度RESTClient進行API再測試，從而實現自動化測試REST API和生成REST API文檔。

3. 問題諮詢與幫助

使用RESTClient過程當中遇到問題能夠查看RESTClient日誌文件：work/log/rest-client.log，這樣很容易排查出問題的具體緣由。

更多的RESTClient使用示例，請參考相關的技術資料來得到更多的使用示例和幫助。