前言
接口調試是每個軟件開發從業者必不可少的一項技能,一個項目的的完成,可能接口測試調試的時間比真正開發寫代碼的時間還要多,幾乎是每個開發的日常工作項。所謂工欲善其事必先利其器,在沒有嘗到 IDEA REST 真香之前,postman(chrome 的一款插件)確實是一個非常不錯的選擇,具有完備的 REST Client 功能和請求歷史記錄功能。但是當使用了 IDEA REST 之后,postman 就可以丟了,因為,IDEA REST Client 具有 postman 的所有功能,而且還有 postman 沒有的功能,繼續往下看。
從 postman 到 IDEA REST Client
真香定律的原因有如下幾個:
- 首先 postman 的所有功能 IDEA REST Client 都具備了,如 REST Client 控制台和歷史請求記錄
- 其次如果能夠在一個生產工具里完成開發和調試的事情,干嘛要切換到另一個工具呢
- 然后 IDEA REST Client 還支持環境配置區分的功能,以及接口響應斷言和腳本化處理的能力
- IDEA REST Client 的請求配置可以用文件配置描述,所以可以跟隨項目和項目成員共享
IDEA REST Client 控制台
從頂層工具欄依次 Tools -> HTTP Client -> Test RESTFUL Web Service 打開后,IDEA REST Client 控制台的界面如下樣式:
可以看到,這個控制台展示的功能區和 postman 已經沒什么差別了,包括請求方式,請求參數和請求頭的填充都已經包含了,特別說明下的是,如果請求的方式是 Authorization :Basic 這種方式認證的話,可以點擊下圖所示的按鈕,會彈出填充用戶名和密碼的窗口出來,填完后會自動補充到 Authorization 的 header 里面去
歷史請求記錄
IntelliJ IDEA 自動將最近執行的 50 個請求保存到 http-requests-log.http 文件中,該文件存儲在項目的.idea / httpRequests / 目錄下。使用請求歷史記錄,您可以快速導航到特定響應並再次發出請求。文件內容大如下圖所示,再次發出請求只要點擊那個運行按鈕即可。如果從請求歷史記錄再次發出請求,則其執行信息和響應輸出的鏈接將添加到請求歷史記錄文件的頂部。
構建 HTTP 請求腳本
上面的歷史記錄就是一個完整的 IDEA REST Client 請求腳本,如果你是從控制台觸發的,那么可以直接復制歷史請求記錄的文件放到項目里作為 HTTP 請求的腳本,給其他成員共享,如果不是,也可以直接新建一個. http 或者. rest 結尾的文件,IDEA 會自動識別為 HTTP 請求腳本。
語法部分
### 演示POST請求
POST {{baseUrl}}}get?show_env=1
Accept: application/json
{
"name":"a"
}
### 演示GET請求
GET {{baseUrl}}}/post
Content-Type: application/x-www-form-urlencoded
id=999&value=content
首先通過 ### 三個井號鍵來分開每個請求體,然后請求 url 和 header 參數是緊緊挨着的,請求參數不管是 POST 的 body 傳參還是 GET 的 parameter 傳參,都是要換行的
環境區分
細心的你可能發現了上面示例的代碼,沒有真實的請求地址,取而代之的,是一個 {{baseUrl}} 的占位符,這個就是 IDEA REST Client 真香的地方,支持從指定的配置文件中獲取到環境相關的配置參數,不僅 baseUrl 可以通過占位符替換,一些請求的參數如果和接口環境相關的都可以通過配置文件來區分。
首先在. http 的腳本同目錄下創建一個名為 http-client.private.env.json 的文件,然后內容如下,一級的 key 值時用來區分環境的,比如,dev、uat、pro 等,環境下的對象就是一次 HTTP 請求中能夠獲取到的環境變量了,你可以直接在請求的 HTTP 的腳本中通過 {{xx}} 占位符的方式獲取到這里配置的參數
{
"uat": {
"baseUrl": "http://gateway.xxx.cn/",
"username": "",
"password": ""
},
"dev": {
"baseUrl": "http://localhsot:8888/",
"username": "",
"password": ""
}
}
那么在選擇執行請求的時候,IDEA 就會讓你選執行那個環境的配置,如:
結果斷言
IDEA REST Client 可以針對接口的響應值進行腳本化的斷言處理,立馬從一個接口調試工具上升到測試工具了,比如:
### Successful test: check response status is 200
GET https://httpbin.org/status/200
> {%
client.test("Request executed successfully", function() {
client.assert(response.status === 200, "Response status is not 200");
});
%}
結果值暫存
試想下這樣的場景,當一個系統需要通過認證才能訪問的時候,如果用 postman 的時候,是不是先訪問登錄接口,然后獲得 token 后,手動粘貼復制到新的調試接口的 header 參數里面去,這太麻煩了,IDEA REST Client 還有一個真香的功能,可以完美解決這個問題,請看下面的腳本:
### 演示POST請求
POST https://httpbin.org/post
Content-Type: application/json
{
"user": "admin",
"password": "123456"
}
> {% client.global.set("auth_token", response.body.json.token); %}
### 演示GET請求
GET https://httpbin.org/headers
Authorization: Bearer {{auth_token}}
在第一個認證的請求結束后,可以在 response 里拿到返回的 token 信息,然后我們通過腳本設置到了全局變量里,那么在接下來的接口請求中,就可以直接使用雙大括號占位符的方式獲取到這個 token 了
結語
postman 有口皆碑,確實是一個非常不錯的必備工具,之前給比人推薦這種工具時總是安利他 postman。但是,IDEA REST Client 也真的很不錯,值得嘗試一下,后面安利這種工具就切換到 IDEA REST Client 了,postman 反正被我丟掉了。和第三方做接口對接時,項目里必備一個 rest-http.http 接口請求文件,滿足自己的同時也成方便了他人。
“不積跬步,無以至千里”,希望未來的你能:有夢為馬 隨處可棲!加油,少年!
關注公眾號:「Java 知己」,每天更新Java知識哦,期待你的到來!
- 發送「Group」,與 10 萬程序員一起進步。
- 發送「面試」,領取BATJ面試資料、面試視頻攻略。
- 發送「玩轉算法」,領取《玩轉算法》系列視頻教程。
- 千萬不要發送「1024」...