• 前言
  • 从邮递员到IDEA REST客户端
  • IDEA REST客户端控制台
  • 历史请求记录
  • 构建HTTP请求脚本
  • 环境区分
  • 结果断言
  • 结果值暂存
  • 结语

前言

内部调试是每个软件开发的从业替代不可少的一项技能，一个项目的完成，可能接口测试调试的时间比真正开发写代码的时间还要多，几乎是每个开发的日常工作项。所谓工欲善其事必先利其器，在没有尝到IDEA REST真香之前，postman(chrome的单个插件)确实是一个非常不错的选择，具有完备的REST Client功能和请求历史记录功能。但是当使用了IDEA REST之后，postman就可以丢了，因为，IDEA REST Client具有postman的所有功能，而且还有postman没有的功能，继续往下看。

从邮递员到IDEA REST客户端

真香定律的原因有如下几个：

  1. 首先邮递员的所有功能IDEA REST客户端都加入了，如REST客户端控制台和历史请求记录
  2. 通常如果能够在一个生产工具里完成开发和调试的事情，干嘛要切换到另一个工具呢
  3. 然后IDEA REST Client还支持环境配置区分的功能，以及接口响应断言和脚本化处理的能力
  4. IDEA REST客户端的请求配置可以用文件配置描述，所以可以跟随项目和项目成员共享

IDEA REST客户端控制台

从顶部工具栏依次工具-> HTTP客户端->测试RESTFUL Web服务：后，IDEA REST客户端控制台的界面如下样式：



可以看到，这个控制台展示的功能区和postman已经没什么区别了，包括请求方式，请求参数和请求头的填充都已经包含了，特别说明下的是，如果请求的方式是授权：基本方式方式认证的话，可以点击下图所示的按钮，会插入替换用户名和密码的窗口出来，填完后会自动补充到授权的标题里面去



历史请求记录

IntelliJ IDEA自动将最近执行的50个请求保存到http-requests-log.http文件中，该文件存储在项目的.idea / httpRequests /目录下。使用请求历史记录，您可以快速导航到特定响应并再次如果从请求历史记录再次发出请求，则其执行信息和响应输出的链接将添加到请求历史记录文件的顶部。



构建HTTP请求脚本

上面的历史记录就是一个完整的IDEA REST客户请求脚本，如果你是从控制台触发的，那么可以直接复制历史请求记录的文件放到项目里作为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

### 演示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的正文传参还是GET的参数传参，都是要换行的

环境区分

细心的你可能发现了上面的示例代码，没有真实的请求地址，取而代之的，是一个{{baseUrl}}的占位符，这个就是IDEA REST Client真香的地方，支持从指定的配置文件中获取到环境相关的配置参数，多个baseUrl可以通过占位符替换，一些请求的参数是否和接口环境相关的都可以通过配置文件来区分。

首先在.http的脚本同目录下创建一个称为http-client.private.env.json的文件，然后内容如下，一级的键值时采用不同的环境，、、 dev，uat，pro等，环境下的对象就是一次HTTP请求中能够获取到的环境变量了，你可以直接在请求的HTTP的脚本中通过{{xx}}占位符的方式获取到此处配置的参数

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

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

那么在选择执行请求的时候，IDEA就会让你选执行那个环境的配置，如：



结果断言

IDEA REST客户端可以针对接口的响应值进行脚本化的断言处理，立马从一个接口调试工具上升到测试工具了，类似：

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

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

结果值暂存

试想下这样的场景，当一个系统需要通过认证才能访问的时候，如果用邮递员的时候，是不是先访问登录接口，然后获得令牌后，手动复制到新的调试接口的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}}

### 演示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}}

在第一个认证的请求结束后，可以在响应里拿到返回的令牌信息，然后我们通过脚本设置到了变量变量里，然后在接下来的接口请求中，就可以直接使用双大括号占位符的方式获取到这个token了

结语

postman有口皆碑，确实是一个非常不错的必备工具，之前给比人推荐这种工具时总是安利他postman。但是，IDEA REST Client也真的很不错，值得尝试一下，后面安利这种工具就切换到IDEA REST客户端了，邮递员反正被我丢掉了。和第三方做接口对接时，项目里必备一个rest-http.http接口请求文件，满足自己的同时也成方便了别人。