Wisdom RESTClient 一款自動(dòng)化測(cè)試REST API的工具，它可以自動(dòng)化測(cè)試RESTful API并生成精美的測(cè)試報(bào)告，同時(shí)基于測(cè)試過(guò)的歷史API，可以生成精美的RESTful API文檔。
JAR包： restclient.jar；
支持的Java版本 >=1.7
雙擊restclient.jar，或者執(zhí)行命令java -jar restclient.jar啟動(dòng)RESTClient軟件。
RESTClient主窗體包含：
在請(qǐng)求視圖中對(duì)所測(cè)試的REST API輸入的數(shù)據(jù)詳情如下：
RESTClient支持請(qǐng)求方法詳情如下：
| 方法名 | 操作 | 備注 |
|---|---|---|
| GET | 查詢 | 無(wú)需要填寫(xiě)請(qǐng)求體 |
| POST | 添加 | |
| PUT | 修改 | |
| DELETE | 刪除 | 無(wú)需要填寫(xiě)請(qǐng)求體 |
URL格式： HTTP協(xié)議://主機(jī)名:端口號(hào)/路徑
重慶分公司
重慶分公司
http://restclient.cn:8080/restapi如果選擇的請(qǐng)求方法是POST或者PUT則可以填寫(xiě)請(qǐng)求體，其他方法則無(wú)需填寫(xiě)。
字符串(String)
直接在請(qǐng)求體的文本框中填寫(xiě)字符串；
文件(File)
瀏覽并選擇地文本文件，文件內(nèi)容會(huì)被讀取并作為請(qǐng)求體。
根據(jù)REST API消息體類型，對(duì)照下表，選擇跟API匹配的內(nèi)容類型，如果表中的內(nèi)容類型都不是API所需要的類型，可以直接在內(nèi)容類型文本框中輸入所需類型。
常見(jiàn)的內(nèi)容類型詳情如下：
| 內(nèi)容類型（Content-Type） | 數(shù)據(jù)格式 |
|---|---|
| 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 |
默認(rèn)字符集是UTF-8，可以選擇REST API所需要的字符集，如果下拉列表里的字符集都不是API所需要的，可以直接在字符集文本框中輸入所需的字符集。
可以根據(jù)REST API定義要求，以鍵值對(duì)的形式添加相應(yīng)的消息頭。
Header鍵值對(duì)示例：
Key ： Accept
Value ： application/json可以根據(jù)REST API定義要求，以鍵值對(duì)的形式添加相應(yīng)的Cookie。
如果API需要登錄認(rèn)證，請(qǐng)先使用瀏覽器完成API登錄認(rèn)證成功后，將瀏覽器生成的JSESSIONID填寫(xiě)到Cookie中，這樣就可以無(wú)需登錄認(rèn)證，直接訪問(wèn)REST API了，免登陸使用詳情參考資料。
Cookie鍵值對(duì)示例：
Key ：JSESSIONID
Value : MY0REST1COOKIE2DEMO3填寫(xiě)完請(qǐng)求數(shù)據(jù)后點(diǎn)擊Start按鈕會(huì)觸發(fā)API請(qǐng)求，在請(qǐng)求視圖中輸入完整的請(qǐng)求數(shù)據(jù)如圖所示：
REST API請(qǐng)求完成后得到響應(yīng)數(shù)據(jù)如下：
響應(yīng)數(shù)據(jù)如圖所示：
在歷史視圖中可以對(duì)API進(jìn)行的可視化編輯如下：
歷史API可視化編輯的快捷菜單如圖所示：
如果需要對(duì)歷史API進(jìn)行再測(cè)試，在RESTClient菜單欄點(diǎn)擊 Test => Start Test
記錄的歷史API測(cè)試完成后，在Windows系統(tǒng)中會(huì)使用默認(rèn)的瀏覽器打開(kāi)測(cè)試報(bào)告。其他系統(tǒng)可以根據(jù)提示框中的報(bào)告路徑，手動(dòng)打開(kāi)測(cè)試報(bào)告。
測(cè)試報(bào)告如圖所示：
如果需要生成API文檔，在RESTClient菜單欄點(diǎn)擊 Apidoc => Create
API文檔生成完成后，在Windows系統(tǒng)中會(huì)使用默認(rèn)的瀏覽器打開(kāi)API文檔。其他系統(tǒng)可以根據(jù)提示框中的文檔路徑，手動(dòng)打開(kāi)API文檔。
API文檔如圖所示：
為了滿足API再測(cè)試要求或者滿足API文檔數(shù)據(jù)要求，可以對(duì)API進(jìn)行如下操作：
歷史視圖中選中API，快捷菜單中選擇Edit打開(kāi)API編輯窗體，如圖所示：
在API編輯窗體中，可以編輯如下內(nèi)容：
默認(rèn)勾選了Assert Body，API再測(cè)試會(huì)對(duì)返回的消息體進(jìn)行完整匹配校驗(yàn)，如果不需要對(duì)返回的消息體進(jìn)行匹配校驗(yàn)，可以去勾選。
如果返回的消息體中的某些JSON節(jié)點(diǎn)不需要進(jìn)行再測(cè)試匹配校驗(yàn)，可以在Viewer視圖上勾選排除這些節(jié)點(diǎn)，這樣API再測(cè)試只對(duì)未排除的節(jié)點(diǎn)進(jìn)行匹配校驗(yàn)。
如果生成的API文檔不能滿足要求，需要改動(dòng)，可以修改數(shù)據(jù)文件work/apidoc/js/apidata.js來(lái)定制API文檔，API定制詳情可以參考資料。
RESTClient支持通過(guò)執(zhí)行命令的方式啟動(dòng)和再測(cè)試API以及生成API文檔，RESTClient CLI使用詳情參考資料。
通過(guò)CLI方式，這樣很容易在Jenkins中定時(shí)執(zhí)行命令來(lái)調(diào)度RESTClient進(jìn)行API再測(cè)試，從而實(shí)現(xiàn)自動(dòng)化測(cè)試REST API和生成REST API文檔。
使用RESTClient過(guò)程中遇到問(wèn)題可以查看RESTClient日志文件：work/log/rest-client.log，這樣很容易排查出問(wèn)題的具體原因。
更多的RESTClient使用示例，請(qǐng)參考相關(guān)的技術(shù)資料來(lái)獲得更多的使用示例和幫助。
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn，海內(nèi)外云服務(wù)器15元起步，三天無(wú)理由+7*72小時(shí)售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢(shì)，專為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場(chǎng)景需求。
