《Dubbo 实现原理与源码解析 —— 精品合集》 《Netty 实现原理与源码解析 —— 精品合集》
《Spring 实现原理与源码解析 —— 精品合集》 《MyBatis 实现原理与源码解析 —— 精品合集》
《数据库实体设计合集》

摘要: 原创出处 http://blog.720ui.com/2018/restclient_use/ 「老梁」欢迎转载,保留摘要,谢谢!


🙂🙂🙂关注微信公众号:【芋道源码】有福利:

  1. RocketMQ / MyCAT / Sharding-JDBC 所有源码分析文章列表
  2. RocketMQ / MyCAT / Sharding-JDBC 中文注释源码 GitHub 地址
  3. 您对于源码的疑问每条留言将得到认真回复。甚至不知道如何读源码也可以请教噢
  4. 新的源码解析文章实时收到通知。每周更新一篇左右
  5. 认真的源码交流微信群。

在日常开发过程中,我们或多或少都涉及到 API 接口的测试。例如,有的小伙伴使用 Chrome 的 Postman 插件,或者使用火狐的 restclient 等工具。事实上,这些工具是测试 API 接口非常有效的方式之一,笔者之前也一直使用 Postman 完成 API 接口的测试工作。今天,笔者推荐另外一个非常好用的小工具,能够帮助读者快速测试 API 接口。这个工具就是 IDEA 的 Editor REST Client

IDEA 的 Editor REST Client 在 IntelliJ IDEA 2017.3 版本就开始支持,在 2018.1 版本添加了很多的特性。事实上,它是 IntelliJ IDEA 的 HTTP Client 插件。

开始工作

首先,我们可以在任意目录下创建一个 xxx.http 文件,如图所示。

这里,我们需要使用 ### 进行 HTTP 请求分割,并在后面添加注释,案例如下所示。

### 用户登录
POST http://localhost:8088/oauth/token?grant_type=password&username=lgz&password=123456
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: Basic client secret
Cache-Control : no-cache

因此,我们获得的响应内容。

多环境配置

在开发过程中,我们通常会存在多套环境,例如开发环境测试环境预发环境生产环境 等。因此,如果 Editor REST Client 能够像 Postman 一样做到多环境配置就太棒了。事实上,Editor REST Client 已经支持了这个特性,我们只需要创建 rest-client.env.json 文件,并且配置多环境信息即可。

{
"development" : {
"url" : "http://localhost:8088",
"token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
},
"test" : {
"url" : "http://localhost:8089",
"token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
},
"preproduction" : {
"url" : "http://activity.720ui.com",
"token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
},
"product" : {
"url" : "http://activity.720ui.com",
"token" : "Bearer 4d74c7fb-0ef4-45ec-b3ff-902eaa3d116c"
}
}

此时,改造之前的 URL,将 http://localhost:8088 改造成 url 代替。

POST {{url}}/oauth/token?grant_type=password&username=lgz&password=123456

这里,我们获得的整体效果。

案例详解

现在,我们来写一个完整的案例。

### 创建用户信息
POST {{url}}/v1/m/users
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: {{token}}
{
"username": "xiaoyue",
"realname": "小岳",
"password": "111111",
"email": "lianggzone@163.com",
"tel": "18305930000",
"weixin": "LiangGzone",
"sex": 1
}

### 修改用户信息
PUT {{url}}/v1/m/users/723181
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: {{token}}
CachePATCH-Control : no-cache
{
"username": "xiaoyue"
}

### 查询用户信息
GET {{url}}/v1/c/users/lgz/username
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: {{token}}

### 查询用户信息列表
GET {{url}}/v1/c/users?keyword=梁
Accept : application/json
Content-Type : application/json;charset=UTF-8
Authorization: {{token}}

参考资料

文章目录
  1. 1. 开始工作
  2. 2. 多环境配置
  3. 3. 案例详解
  4. 4. 参考资料