一、安装插件
要使用Idea接口测试插件,首先需要安装该插件。步骤如下:
1、打开Idea,选择File->Settings->Plugins,在搜索框中搜索“RestfulToolkit”插件并点击“Install”进行安装。
2、安装完成之后,需要重启Idea才能生效。
二、创建测试文件
在完成插件的安装之后,就可以创建一个测试文件并开始测试了。步骤如下:
1、在Idea的项目目录下创建一个文件夹用来存放测试文件。
//测试文件夹结构如下:
test
|--interface_test.json
2、在test文件夹下新建一个json文件,文件名随意命名。
//文件内容示例:
{
"name": "interface_test",
"requests": [
{
"name": "get_example",
"url": "https://www.example.com",
"method": "GET"
}
]
}
此时,我们已经成功创建了一个基本的测试文件。
三、测试请求
我们可以在测试文件中添加多个请求,以完成不同接口的测试。同时,Idea接口测试插件支持多种请求类型,包括GET、POST、PUT、DELETE等。下面我们来对一个请求进行测试。步骤如下:
1、在测试文件中添加一个请求。
//新增一个POST请求示例:
{
"name": "post_example",
"url": "https://www.example.com",
"method": "POST",
"headers": {
"Content-Type": "application/json"
},
"params": {
"name": "example",
"age": 18
},
"body": {
"message": "Hello World!"
}
}
2、点击测试文件右侧的“Test”按钮,选择“Test file”或“Test request”进行测试。
//测试结果示例:
POST https://www.example.com
Headers:
Content-Type: application/json
Params:
name = example
age = 18
Body:
{
"message": "Hello World!"
}
Response:
Status code: 200 OK
Headers:
Content-Type: application/json;charset=utf-8
Body:
{
"result": "success"
}
四、集成测试框架
Idea接口测试插件还支持与Junit、TestNG等测试框架进行集成。下面我们来看一下如何对测试文件进行集成测试。步骤如下:
1、在Idea的项目结构中,新建一个Java类,并给它取个名字。
//Java类的示例代码:
public class InterfaceTest {
@Test
public void testInterface() throws Exception{
RestTester tester = new RestTester();
tester.testFile("test/interface_test.json");
}
}
2、运行Java类中的测试方法。
//运行结果示例:
POST https://www.example.com
Headers:
Content-Type: application/json
Params:
name = example
age = 18
Body:
{
"message": "Hello World!"
}
Response:
Status code: 200 OK
Headers:
Content-Type: application/json;charset=utf-8
Body:
{
"result": "success"
}
五、使用变量
在测试过程中,我们有时需要用到某些固定的参数或者变量,Idea接口测试插件支持在测试文件中使用变量。步骤如下:
1、在测试文件中添加一个变量。
//新增一个变量示例:
{
"name": "var_example",
"variables": {
"example_id": "123456"
},
"requests": [
{
"name": "get_example",
"url": "https://www.example.com/{{example_id}}",
"method": "GET"
}
]
}
2、在测试文件中的请求中使用该变量。
//请求部分示例代码:
{
"name": "get_example",
"url": "https://www.example.com/{{example_id}}",
"method": "GET"
}
3、在测试文件中设置变量的值。
//设置变量示例代码:
{
"name": "var_example",
"variables": {
"example_id": "123456"
}
}
此时,我们的请求将会使用该变量,请求的URL为“https://www.example.com/123456”。
六、使用脚本
在测试文件中,我们可以使用一些JavaScript脚本进行更为灵活的测试。脚本支持针对请求头、请求参数、请求体、响应头、响应体进行操作,也支持通用的脚本操作。下面我们来看几个JavaScript脚本的示例。步骤如下:
1、在测试文件中添加一个包含脚本的请求。
//新增一个包含脚本的请求示例:
{
"name": "script_example",
"url": "https://www.example.com",
"method": "POST",
"headers": {
"Content-Type": "application/json"
},
"params": {
"name": "example",
"age": 18
},
"body": {
"message": "Hello World!"
},
"scripts": {
"request": [
{
"enabled": true,
"type": "header",
"field": "Authorization",
"value": "Bearer {{access_token}}"
},
{
"enabled": true,
"type": "body",
"field": "message",
"value": "Hello Example!"
},
{
"enabled": true,
"type": "param",
"field": "age",
"value": "20"
}
]
}
}
2、在测试文件中添加一个脚本文件。
//新建一个脚本文件example.js,并将其放置在test文件夹下:
function auth(content){
if(content.statusCode == 200){
return "Bearer " + JSON.parse(content.body).access_token;
}
}
function result(content){
if(content.statusCode == 200){
return "success";
}else{
return "failed";
}
}
3、在测试文件中设置脚本的变量值。
//设置脚本变量的值示例代码:
{
"name": "script_example",
"variables": {
"access_token": "1234567890"
}
}
此时,我们的请求将会使用该脚本,对请求的头、参数、体进行了定制化,并且随着access_token的不同,脚本的返回值也会相应改变。
总结
以上是Idea接口测试插件的使用方法及详解。在使用该插件进行接口测试时,有了以上的内容,相信会对您的工作有所裨益,快去试试吧。