服务器之家

服务器之家 > 正文

关于快速测试API接口的一个新技能

时间:2021-05-08 12:14     来源/作者:梁桂钊

前言

我们大家在日常开发过程中,或多或少都涉及到 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 文件,如图所示。

关于快速测试API接口的一个新技能

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

?
1
2
3
4
5
6
### 用户登录
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

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

关于快速测试API接口的一个新技能

多环境配置

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
 "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 代替。

?
1
post /oauth/token?grant_type=password&username=lgz&password=123456

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

关于快速测试API接口的一个新技能

案例详解

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

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
### 创建用户信息
post /v1/m/users
accept : application/json
content-type : application/json;charset=utf-8
authorization:
{
 "username": "xiaoyue",
 "realname": "小岳",
 "password": "111111",
 "email": "lianggzone@163.com",
 "tel": "18305930000",
 "weixin": "lianggzone",
 "sex": 1
}
 
### 修改用户信息
put /v1/m/users/723181
accept : application/json
content-type : application/json;charset=utf-8
authorization:
cachepatch-control : no-cache
{
 "username": "xiaoyue"
}
 
### 查询用户信息
get /v1/c/users/lgz/username
accept : application/json
content-type : application/json;charset=utf-8
authorization:
 
### 查询用户信息列表
get /v1/c/users?keyword=梁
accept : application/json
content-type : application/json;charset=utf-8
authorization:

参考资料

https://marketplace.visualstudio.com/items?itemname=humao.rest-clientt

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对服务器之家的支持。

原文链接:http://blog.720ui.com/2018/restclient_use/

标签:

相关文章

热门资讯

2020微信伤感网名听哭了 让对方看到心疼的伤感网名大全
2020微信伤感网名听哭了 让对方看到心疼的伤感网名大全 2019-12-26
yue是什么意思 网络流行语yue了是什么梗
yue是什么意思 网络流行语yue了是什么梗 2020-10-11
背刺什么意思 网络词语背刺是什么梗
背刺什么意思 网络词语背刺是什么梗 2020-05-22
苹果12mini价格表官网报价 iPhone12mini全版本价格汇总
苹果12mini价格表官网报价 iPhone12mini全版本价格汇总 2020-11-13
Intellij idea2020永久破解,亲测可用!!!
Intellij idea2020永久破解,亲测可用!!! 2020-07-29
返回顶部