關(guān)注我們,設(shè)為星標(biāo),每天7:30不見不散,架構(gòu)路上與您共享 
回復(fù)"架構(gòu)師"獲取資源

作者：凱京技術(shù)團(tuán)隊
https://my.oschina.net/keking/blog/3104972

前言

接口調(diào)試是每個軟件開發(fā)從業(yè)者必不可少的一項技能，一個項目的的完成，可能接口測試調(diào)試的時間比真正開發(fā)寫代碼的時間還要多，幾乎是每個開發(fā)的日常工作項。所謂工欲善其事必先利其器，在沒有嘗到 IDEA REST 真香之前，postman（chrome 的一款插件）確實是一個非常不錯的選擇，具有完備的 REST Client 功能和請求歷史記錄功能。但是當(dāng)使用了 IDEA REST 之后，postman 就可以丟了，因為，IDEA REST Client 具有 postman 的所有功能，而且還有 postman 沒有的功能，繼續(xù)往下看。

從 postman 到 IDEA REST Client

真香定律的原因有如下幾個：

首先 postman 的所有功能 IDEA REST Client 都具備了，如 REST Client 控制臺和歷史請求記錄
其次如果能夠在一個生產(chǎn)工具里完成開發(fā)和調(diào)試的事情，干嘛要切換到另一個工具呢
然后 IDEA REST Client 還支持環(huán)境配置區(qū)分的功能，以及接口響應(yīng)斷言和腳本化處理的能力
IDEA REST Client 的請求配置可以用文件配置描述，所以可以跟隨項目和項目成員共享

IDEA REST Client 控制臺

從頂層工具欄依次 Tools -> HTTP Client -> Test RESTFUL Web Service 打開后，IDEA REST Client 控制臺的界面如下樣式：

可以看到，這個控制臺展示的功能區(qū)和 postman 已經(jīng)沒什么差別了，包括請求方式，請求參數(shù)和請求頭的填充都已經(jīng)包含了，特別說明下的是，如果請求的方式是 Authorization :Basic 這種方式認(rèn)證的話，可以點擊下圖所示的按鈕，會彈出填充用戶名和密碼的窗口出來，填完后會自動補充到 Authorization 的 header 里面去

歷史請求記錄

IntelliJ IDEA 自動將最近執(zhí)行的 50 個請求保存到 http-requests-log.http 文件中，該文件存儲在項目的.idea / httpRequests / 目錄下。使用請求歷史記錄，您可以快速導(dǎo)航到特定響應(yīng)并再次發(fā)出請求。文件內(nèi)容大如下圖所示，再次發(fā)出請求只要點擊那個運行按鈕即可。如果從請求歷史記錄再次發(fā)出請求，則其執(zhí)行信息和響應(yīng)輸出的鏈接將添加到請求歷史記錄文件的頂部。

構(gòu)建 HTTP 請求腳本

上面的歷史記錄就是一個完整的 IDEA REST Client 請求腳本，如果你是從控制臺觸發(fā)的，那么可以直接復(fù)制歷史請求記錄的文件放到項目里作為 HTTP 請求的腳本，給其他成員共享，如果不是，也可以直接新建一個. http 或者. rest 結(jié)尾的文件，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 參數(shù)是緊緊挨著的，請求參數(shù)不管是 POST 的 body 傳參還是 GET 的 parameter 傳參，都是要換行的

環(huán)境區(qū)分

細(xì)心的你可能發(fā)現(xiàn)了上面示例的代碼，沒有真實的請求地址，取而代之的，是一個 {{baseUrl}} 的占位符，這個就是 IDEA REST Client 真香的地方，支持從指定的配置文件中獲取到環(huán)境相關(guān)的配置參數(shù)，不僅 baseUrl 可以通過占位符替換，一些請求的參數(shù)如果和接口環(huán)境相關(guān)的都可以通過配置文件來區(qū)分。

首先在. http 的腳本同目錄下創(chuàng)建一個名為 http-client.private.env.json 的文件，然后內(nèi)容如下，一級的 key 值時用來區(qū)分環(huán)境的，比如，dev、uat、pro 等，環(huán)境下的對象就是一次 HTTP 請求中能夠獲取到的環(huán)境變量了，你可以直接在請求的 HTTP 的腳本中通過 {{xx}} 占位符的方式獲取到這里配置的參數(shù)

{
  "uat": {
    "baseUrl": "http://gateway.xxx.cn/",
    "username": "",
    "password": ""
  },
  "dev": {
    "baseUrl": "http://localhsot:8888/",
    "username": "",
    "password": ""
  }
}

那么在選擇執(zhí)行請求的時候，IDEA 就會讓你選執(zhí)行那個環(huán)境的配置，如：

結(jié)果斷言

IDEA REST Client 可以針對接口的響應(yīng)值進(jìn)行腳本化的斷言處理，立馬從一個接口調(diào)試工具上升到測試工具了，比如：

### 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");
});
%}

結(jié)果值暫存

試想下這樣的場景，當(dāng)一個系統(tǒng)需要通過認(rèn)證才能訪問的時候，如果用 postman 的時候，是不是先訪問登錄接口，然后獲得 token 后，手動粘貼復(fù)制到新的調(diào)試接口的 header 參數(shù)里面去，這太麻煩了，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}}

在第一個認(rèn)證的請求結(jié)束后，可以在 response 里拿到返回的 token 信息，然后我們通過腳本設(shè)置到了全局變量里，那么在接下來的接口請求中，就可以直接使用雙大括號占位符的方式獲取到這個 token 了

結(jié)語

postman 有口皆碑，確實是一個非常不錯的必備工具，之前給比人推薦這種工具時總是安利他 postman。但是，IDEA REST Client 也真的很不錯，值得嘗試一下，后面安利這種工具就切換到 IDEA REST Client 了，postman 反正被我丟掉了。和第三方做接口對接時，項目里必備一個 rest-http.http 接口請求文件，滿足自己的同時也成方便了他人。

到此文章就結(jié)束了。如果今天的文章對你在進(jìn)階架構(gòu)師的路上有新的啟發(fā)和進(jìn)步，歡迎轉(zhuǎn)發(fā)給更多人。歡迎加入架構(gòu)師社區(qū)技術(shù)交流群，眾多大咖帶你進(jìn)階架構(gòu)師，在后臺回復(fù)“加群”即可入群。

這些年小編給你分享過的干貨

1.SpringBoot物流管理項目，拿去學(xué)習(xí)吧（附源碼）

2.ERP系統(tǒng)，自帶進(jìn)銷存+財務(wù)+生產(chǎn)功能，拿來即用（附源碼）

3.帶工作流的SpringBoot后臺管理項目快速開發(fā)（附源碼）
4.最好的OA系統(tǒng)，拿來即用，非常方便（附源碼）

5.SpringBoot+Vue完整的外賣系統(tǒng)，手機端和后臺管理，附源碼！

6.SpringBoot+Vue 可視化拖拽編輯的大屏項目（附源碼）

轉(zhuǎn)發(fā)在看就是最大的支持??

學(xué)會IDEA REST Client后，postman就可以丟掉了...

前言