看了網上好多的 idea rest client 講解,大多都只是講了它如何如何好,都只是簡單的測了一個 json 的接口而已,個人實踐了一把,里面還是有挺多坑的,但不得不說,那個腳本化處理請求的功能確實挺棒。
腳本化配置確實很方便,linux 使用文件來配置環境變量代替了windows 的可視化配置,sublime 使用文件來配置它的所有配置項取代傳統的可視化配置,這種文件化的方式可以做到可遷移,多端即時同步和多人共享,有過經歷的人自然懂我在說什么。
本文內容:
關於腳本化 mock 的實踐,免復制 token 實踐,文件傳輸實踐
關於語法
請求的語法基本上和 http 協議內容是一致的,結構如下
### 使用三個 # 來分隔多個請求
GET/POST 請求地址(可拼接查詢參數)
請求頭鍵值對
請求體
> {% %}
# 響應處理 > 打頭和 shell 很像,然后用 {% %} 括起來的腳本內容 ,在腳本中可以使用 javascript 原生語法,這就很強大了
# 腳本中有幾個內置對象 client 表示當前客戶端,response 表示響應結果
對於這個使用文檔,我在官網沒有找到對應的文檔位置,但在 idea 本身提供了一些不錯的使用示例,它的位置在 Tools/HTTP Client/Open HTTP Requests Collection
每發送一個請求后,你可以在歷史記錄中找到它,idea 會為你保存最近 50 條請求,保存的是編譯后的請求,當你發送的請求的響應結果和實際不符時,你可以在這里找到問題的原因,它在項目的 .idea/httpRequests
文件夾中。
常用示例
配置環境信息
這也是它比較強大的一方面,使用一個 json 來配置所有環境,只要在請求腳本目錄下就可以讀到,遵循約定大於配置的原則,文件名 http-client.env.json
表示普通變量可放的地方 http-client.private.env.json
表示密碼等私有變量配置的地方,配置大致如下。在運行請求腳本的時候,idea 會提示你要選哪個環境
{
"local":{
"baseUrl": "http://localhost:8083/",
"checkCode": "http://localhost:8081/sanritools/company/token?env=dev",
},
"dev": {
"baseUrl": "http://devhost:port/",
"checkCode": "http://localhost:8081/sanritools/company/token?env=dev",
},
"sit": {
"baseUrl": "http://sithost:port/",
"checkCode": "http://localhost:8081/sanritools/company/token?env=sit",
}
}
登錄 token 示例
網上的示例基本上都是在說,用一個接口獲取到 token ,然后保存到全局變量中,然后后面的接口就可以直接使用了,代碼如下,但是本人試了無數次都沒成功,再者,你們項目都沒驗證碼的嗎。
### 獲取 token 值
GET {{checkCode}}
Content-Type: application/json
> {%
client.global.set("token", response.body.token);
%}
### 獲取素材列表
POST {{baseUrl}}/media/list
Content-Type: application/json
Authorization: {{token}}
{
"pageNo": 1,
"pageSize": 10
}
上面這個是有問題的,返回值 response.body 其它是個 json 字符串並非 javascript 對象,需要解析一下,前面也說了,這里可以使用原生 javascript 腳本,所以 JSON.parse(response.body).token
才能正確獲取到 token ,
第二個問題,我們現在這個 token 是存在 redis 的,所以我可以繞過驗證碼,另寫一個接口去 redis 直接獲取 token ,腳本最終如下
### 獲取 token 值
GET {{checkCode}}
Content-Type: application/json
> {%
client.global.set("token", JSON.parse(response.body).token);
%}
### 獲取素材列表
POST {{baseUrl}}/media/list
Content-Type: application/json
Authorization: {{token}}
{
"pageNo": 1,
"pageSize": 10
}
文件傳輸實踐
前面說了,輸入輸出和 shell 中很像,所以這里輸入一個文件使用 < 文件地址
,隨便找個 multipart/form-data
的數據格式查看一下,就知道文件怎么傳了,其實在示例中也有,如下面腳本所示,它使用一個 boundary 的 key 綁定當前所要提交多個 part 的數據,每個 part 可以是不同的數據格式 ;
### 測試發送文件信息(文件元數據信息查詢)
POST {{baseUrl}}/media/upload/fileMetaData
Content-Type: multipart/form-data; boundary=WebAppBoundary
Authorization: {{token}}
--WebAppBoundary
Content-Disposition: form-data; name="fileSize"
Content-Type: application/json
1024
--WebAppBoundary
Content-Disposition: form-data; name="md5"
Content-Type: application/json
sdafasdfasfd
--WebAppBoundary
Content-Disposition: form-data; name="partFile"; filename="zhongwenbuxin.avi"
Content-Type: application/octet-stream
< C:\Users\091795960\Videos/V0106_1024KB.avi
--WebAppBoundary--
對於返回信息亂碼我沒有碰到,也沒有設置網上說的消息頭和啟動配置,返回消息是正常編碼的;我只碰到了上傳上去的文件名是亂碼的,怎么設置都不生效,沒找到解決辦法,但自測的話,取個英文名也沒關系,有哪位大神解決了可以告訴我一下。
關於其它斷言的使用,和日志的使用可以找其它的博客,這里列一篇以供參考
https://www.cnblogs.com/zhixie/p/12059593.html
一點小推廣
創作不易,希望可以支持下我的開源軟件,及我的小工具,歡迎來 gitee 點星,fork ,提 bug 。
Excel 通用導入導出,支持 Excel 公式
博客地址:https://blog.csdn.net/sanri1993/article/details/100601578
gitee:https://gitee.com/sanri/sanri-excel-poi
使用模板代碼 ,從數據庫生成代碼 ,及一些項目中經常可以用到的小工具
博客地址:https://blog.csdn.net/sanri1993/article/details/98664034
gitee:https://gitee.com/sanri/sanri-tools-maven