往期熱門(mén)文章：
1、推薦一款 Spring Boot 的 HTTP 客戶(hù)端框架
2、牛逼！SpringBoot+Vue企業(yè)級(jí)支付系統(tǒng)！附源碼！
3、面試官：二維碼掃碼登錄是個(gè)啥原理
4、Spring Boot + Vue 如此強(qiáng)大？

---

作者：凱京技術(shù)團(tuán)隊(duì)

https://my.oschina.net/keking/blog/3104972

前言

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

從 postman 到 IDEA REST Client

真香定律的原因有如下幾個(gè)：

1. 首先 postman 的所有功能 IDEA REST Client 都具備了，如 REST Client 控制臺(tái)和歷史請(qǐng)求記錄

2. 其次如果能夠在一個(gè)生產(chǎn)工具里完成開(kāi)發(fā)和調(diào)試的事情，干嘛要切換到另一個(gè)工具呢

3. 然后 IDEA REST Client 還支持環(huán)境配置區(qū)分的功能，以及接口響應(yīng)斷言和腳本化處理的能力

4. IDEA REST Client 的請(qǐng)求配置可以用文件配置描述，所以可以跟隨項(xiàng)目和項(xiàng)目成員共享

IDEA REST Client 控制臺(tái)

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

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

歷史請(qǐng)求記錄

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

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

上面的歷史記錄就是一個(gè)完整的 IDEA REST Client 請(qǐng)求腳本，如果你是從控制臺(tái)觸發(fā)的，那么可以直接復(fù)制歷史請(qǐng)求記錄的文件放到項(xiàng)目里作為 HTTP 請(qǐng)求的腳本，給其他成員共享，如果不是，也可以直接新建一個(gè). http 或者. rest 結(jié)尾的文件，IDEA 會(huì)自動(dòng)識(shí)別為 HTTP 請(qǐng)求腳本。

語(yǔ)法部分

### 演示POST請(qǐng)求
POST {{baseUrl}}}get?show_env=1
Accept: application/json

{
   "name":"a"
}
### 演示GET請(qǐng)求

GET {{baseUrl}}}/post
Content-Type: application/x-www-form-urlencoded

id=999&value=content

首先通過(guò) ### 三個(gè)井號(hào)鍵來(lái)分開(kāi)每個(gè)請(qǐng)求體，然后請(qǐng)求 url 和 header 參數(shù)是緊緊挨著的，請(qǐng)求參數(shù)不管是 POST 的 body 傳參還是 GET 的 parameter 傳參，都是要換行的

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

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

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

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

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

結(jié)果斷言

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

### 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é)果值暫存

試想下這樣的場(chǎng)景，當(dāng)一個(gè)系統(tǒng)需要通過(guò)認(rèn)證才能訪(fǎng)問(wèn)的時(shí)候，如果用 postman 的時(shí)候，是不是先訪(fǎng)問(wèn)登錄接口，然后獲得 token 后，手動(dòng)粘貼復(fù)制到新的調(diào)試接口的 header 參數(shù)里面去，這太麻煩了，IDEA REST Client 還有一個(gè)真香的功能，可以完美解決這個(gè)問(wèn)題，請(qǐng)看下面的腳本：

### 演示POST請(qǐng)求
POST https://httpbin.org/post
Content-Type: application/json

{
  "user": "admin",
  "password": "123456"
}

> {% client.global.set("auth_token", response.body.json.token); %}
### 演示GET請(qǐng)求

GET https://httpbin.org/headers
Authorization: Bearer {{auth_token}}

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

結(jié)語(yǔ)

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

如果看到這里，說(shuō)明你喜歡這篇文章，請(qǐng) 轉(zhuǎn)發(fā)、點(diǎn)贊。同時(shí) 標(biāo)星（置頂）本公眾號(hào)可以第一時(shí)間接受到博文推送。
推薦閱讀：（點(diǎn)擊標(biāo)題可跳轉(zhuǎn)）

這 56 個(gè)代碼注釋讓我笑吐了
基于 SpringBoot + Vue 的前后端分離的考試系統(tǒng)
干掉 XML Mapper，新出的 Fluent Mybatis 真香！
最牛逼的性能監(jiān)控系統(tǒng)！集強(qiáng)大功能于一身
21 款 yyds 的 IDEA插件

編程·技術(shù)·經(jīng)驗(yàn)
歡迎掃碼關(guān)注