你還在用 Postman?IDEA REST Client 好用到爆,Postman 可以扔了...
來源:my.oschina.net/keking/blog/3104972
前言
介面除錯是每個軟體開發從業者必不可少的一項技能,一個專案的的完成,可能介面測試除錯的時間比真正開發寫程式碼的時間還要多,幾乎是每個開發的日常工作項。所謂工欲善其事必先利其器。
在沒有嚐到IDEA REST真香之前,postman(chrome的一款外掛)確實是一個非常不錯的選擇,具有完備的REST Client功能和請求歷史記錄功能。但是當使用了IDEA REST之後,postman就可以丟了,因為,IDEA REST Client具有postman的所有功能,而且還有postman沒有的功能,繼續往下看。
另外,Java 系列面試題和答案全部整理好了,微信搜尋Java技術棧,在後臺傳送:面試,可以線上閱讀。
從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介面請求檔案,滿足自己的同時也成方便了他人。
近期熱文推薦:
1.1,000+ 道 Java面試題及答案整理(2021最新版)
2.別在再滿屏的 if/ else 了,試試策略模式,真香!!
3.臥槽!Java 中的 xx ≠ null 是什麼新語法?
4.Spring Boot 2.5 重磅釋出,黑暗模式太炸了!
覺得不錯,別忘了隨手點贊+轉發哦!