是時候扔掉 Postman 了,試試 IntelliJ IDEA 自帶的高能神器

前言json

接口調試是每一個軟件開發從業者必不可少的一項技能,一個項目的的完成,可能接口測試調試的時間比真正開發寫代碼的時間還要多,幾乎是每[個開發的平常工做項。]微信

所謂工欲善其事必先利其器,在沒有嚐到 IDEA REST 真香以前, postman 確實是一個很是不錯的選擇,具備完備的 REST Client 功能和請求歷史記錄功能。可是當使用了 IDEA REST 以後,postman 就能夠丟了,由於,IDEA REST Client 具備 postman 的全部功能,並且還有postman 沒有的功能,繼續往下看。app

從 postman 到 IDEA REST Clientide

真香定律的緣由有以下幾個:工具

  1. 首先 postman 的全部功能 IDEA REST Client 都具有了,如 REST Client 控制檯和歷史請求記錄post

  2. 其次若是可以在一個生產工具裏完成開發和調試的事情,幹嗎要切換到另外一個工具呢測試

  3. 而後 IDEA REST Client 還支持環境配置區分的功能,以及接口響應斷言和腳本化處理的能力url

  4. IDEA REST Client 的請求配置能夠用文件配置描述,因此能夠跟隨項目和項目成員共享idea

IDEA REST Client 控制檯spa

從頂層工具欄依次 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 接口請求文件,知足本身的同時也成方便了他人。


本文分享自微信公衆號 - 願天堂沒有BUG(ma214617)。
若有侵權,請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」,歡迎正在閱讀的你也加入,一塊兒分享。

相關文章
相關標籤/搜索