前言

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

從postman到IDEA REST Client

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

1. 首先postman的所有功能IDEA REST Client都具備了，如REST Client控制臺(tái)和歷史請(qǐng)求記錄
2. 其次如果能夠在一個(gè)生產(chǎn)工具里完成開發(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 打開后，IDEA REST Client控制臺(tái)的界面如下樣式：

可以看到，這個(gè)控制臺(tái)展示的功能區(qū)和postman已經(jīng)沒什么差別了，包括請(qǐng)求方式，請(qǐng)求參數(shù)和請(qǐng)求頭的填充都已經(jīng)包含了，特別說明下的是，如果請(qǐng)求的方式是Authorization :Basic這種方式認(rèn)證的話，可以點(diǎn)擊下圖所示的按鈕，會(huì)彈出填充用戶名和密碼的窗口出來，填完后會(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

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

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

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

首先在.http的腳本同目錄下創(chuàng)建一個(gè)名為http-client.private.env.json的文件，然后內(nèi)容如下，一級(jí)的key值時(shí)用來區(qū)分環(huán)境的，比如，dev、uat、pro等，環(huán)境下的對(duì)象就是一次HTTP請(qǐng)求中能夠獲取到的環(huán)境變量了，你可以直接在請(qǐng)求的HTTP的腳本中通過{{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)需要通過認(rèn)證才能訪問的時(shí)候，如果用postman的時(shí)候，是不是先訪問登錄接口，然后獲得token后，手動(dòng)粘貼復(fù)制到新的調(diào)試接口的header參數(shù)里面去，這太麻煩了，IDEA REST Client還有一個(gè)真香的功能，可以完美解決這個(gè)問題，請(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信息，然后我們通過腳本設(shè)置到了全局變量里，那么在接下來的接口請(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)求文件，滿足自己的同時(shí)也成方便了他人。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論