作者:凱京技術團隊
連結:https://my.oschina.net/keking/blog/3104972
正文
- 從postman到IDEA REST Client
- IDEA REST Client控制台
- 曆史請求記錄
- 建構HTTP請求腳本
- 環境區分
- 結果斷言
- 結果值暫存
- 結語
前言
接口調試是每個軟體開發從業者必不可少的一項技能,一個項目的的完成,可能接口測試調試的時間比真正開發寫代碼的時間還要多,幾乎是每個開發的日常工作項。
所謂工欲善其事必先利其器,在沒有嘗到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=1Accept: application/json{ "name":"a"}### 示範GET請求GET {{baseUrl}}}/postContent-Type: application/x-www-form-urlencodedid=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 200GET 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/postContent-Type: application/json{ "user": "admin", "password": "123456"}> {% client.global.set("auth_token", response.body.json.token); %}### 示範GET請求GET https://httpbin.org/headersAuthorization: Bearer {{auth_token}}
複制
在第一個認證的請求結束後,可以在response裡拿到傳回的token資訊,然後我們通過腳本設定到了全局變量裡,那麼在接下來的接口請求中,就可以直接使用雙大括号占位符的方式擷取到這個token了
結語
postman有口皆碑,确實是一個非常不錯的必備工具,之前給比人推薦這種工具時總是安利他postman。
但是,IDEA REST Client也真的很不錯,值得嘗試一下,後面安利這種工具就切換到IDEA REST Client了,postman反正被我丢掉了。
和第三方做接口對接時,項目裡必備一個rest-http.http接口請求檔案,滿足自己的同時也成友善了他人。
複制