Java基于Rest Assured自动化测试接口详解

更新时间：2023年03月21日 08:26:38 作者：JAVA旭阳

Rest Assured 是一个基于 Java 的流行的用于测试 RESTful API 的库。这篇文章主要介绍了Java如何基于Rest Assured实现自动化测试接口，需要的可以参考一下

前言

不知道大家的项目是否都有对接口API进行自动化测试，反正像我们这种小公司是没有的。由于最近一直被吐槽项目质量糟糕，只能研发自己看看有什么接口测试方案。那么在本文中，我将探索如何使用 Rest Assured 自动化 API 测试，Rest Assured 是一个基于 Java 的流行的用于测试 RESTful API 的库。

什么是Rest Assured

Rest Assured 是一个基于 Java 的开源库，主要用于测试 RESTful API。它为编写测试用例提供了一种简单直观的 DSL（领域特定语言），这使得开发人员可以轻松编写和维护自动化测试。Rest Assured 支持 GET、POST、PUT、DELETE、PATCH 等各种 HTTP 方法，并且可以轻松与流行的测试框架（如 TestNG 和 JUnit）集成。

github地址：https://github.com/rest-assured/rest-assured

安装Rest Assured

在maven中引入相关依赖

<dependency>
  <groupId>io.rest-assured</groupId>
  <artifactId>rest-assured</artifactId>
  <version>5.3.0</version>
  <scope>test</scope>
</dependency>

Rest Assured结构

Rest Assured代码的整体结构分为 3 个主要部分:

1.Given

Given是 API 测试的先决条件，可以在其中设置测试所需的一切，例如URL、请求头或参数，或任何需要满足的先决条件。
可以在“Given”中设置的内容：URL、请求头、请求参数和请求正文。

2.When

When是实际向服务器发送 HTTP 请求并获得响应的时间。可以在When中定义请求方法，如 GET、POST、PUT 等。

3.Then

Then是您检查从服务器获得的响应并确保它符合您的预期的地方。在这您可以检查状态代码、响应正文、标头或任何其他对您的测试很重要的内容。

Show Me Code

我们现在通过一个例子来演示下如何使用Rest Assured，首先我们看下postman的例子：

1.请求参数

2.请求头

3.请求体

现在我们用Rest Assured这个框架来测试下上面postman的这个接口。

import io.restassured.builder.RequestSpecBuilder;
import io.restassured.response.Response;
import io.restassured.specification.RequestSpecification;
import org.testng.annotations.Test;

import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.lessThan;

public class TestRestAssured {
    @Test
    public void testMyApi() {
        String jsonBody = "{"email":"dhadiprasetyo@gmail.com","uid":"Jzr0sOORprar10kay6CweZ5FNYP2"}";

        Response response = given().baseUri("http://127.0.0.1:8000")
            .queryParam("version", "1.0")
            .header("Authorization", "yourauthhere")
            .header("Signature", "yoursignaturehere")
            .body(jsonBody)
            .when().post("/getuserdata/")
            .then().assertThat().statusCode(200)
            .header("Content-Type", "application/json")
            .header("Cache-Control", "max-age=3600")
            .body("name", equalTo("Darmawan Hadiprasetyo"))
            .time(lessThan(5000L))
            .extract().response();
    }
}

1.首先我们在 given() 中设置前置条件

given().baseUri("http://127.0.0.1:8000")
    .queryParam("version", "1.0")
    .header("Authorization", "yourauthhere")
    .header("Signature", "yoursignaturehere")
    .body(jsonBody)

2.然后在when()中定义请求方法，本例中为POST

.when().post("/getuserdata/")

3.然后我们从我们的请求中断言状态代码、标头、正文和响应时间

.then().assertThat().statusCode(200)
    .header("Content-Type", "application/json")
    .header("Cache-Control", "max-age=3600")
    .body("name", equalTo("Darmawan Hadiprasetyo"))
    .time(lessThan(5000L))
    .extract().response();

如何提取响应体?

例如，这将是我们对之前请求的回应：

{
  "name": "alvin",
  "role": "SDET"
}

以下是我们如何提取这些数据：

JsonPath responseBody = response.jsonPath();
String fullName = responseBody.getString("name");
String role = responseBody.getString("role");

统一抽象封装

在大多数情况下，需要测试许多 API，但前提条件相同，例如 BaseURL、参数和请求头等，为了消除代码中的冗余，我们可以统一抽象封装一个 RequestSpecification 类作为我们的规范构建器，并在我们的其他测试中重用它，如下所示：

import io.restassured.builder.RequestSpecBuilder;
import io.restassured.path.json.JsonPath;
import io.restassured.response.Response;
import io.restassured.specification.RequestSpecification;
import org.testng.annotations.Test;

import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.lessThan;

public class TestRestAssured {
    public static RequestSpecification requestSpecification() {
        return new RequestSpecBuilder().setBaseUri("http://127.0.0.1:8000")
            .addQueryParam("version", "1.0")
            .addHeader("Authorization", "yourauthhere")
            .addHeader("Signature", "yoursignaturehere")
            .build();
    }

    @Test
    public void testMyApi() {
        String jsonBody = "{"email":"dhadiprasetyo@gmail.com","uid":"Jzr0sOORprar10kay6CweZ5FNYP2"}";

        Response response = given().spec(requestSpecification())
            .body(jsonBody)
            .when().post("/getuserdata/")
            .then().assertThat().statusCode(200)
            .header("Content-Type", "application/json")
            .header("Cache-Control", "max-age=3600")
            .body("name", equalTo("Darmawan Hadiprasetyo"))
            .time(lessThan(5000L))
            .extract().response();

        JsonPath responseBody = response.jsonPath();
        String fullName = responseBody.getString("name");
        String linkedIn = responseBody.getString("linkedin");
        String role = responseBody.getString("role");
    }
}

现在，您可以在具有相同前提条件的任何其他需要的测试中重用 requestSpecification() 方法。查看与我们之前代码的区别：

// previous
Response response = given().baseUri("http://127.0.0.1:8000")
    .queryParam("version", "1.0")
    .header("Authorization", "yourauthhere")
    .header("Signature", "yoursignaturehere")
    .body(jsonBody)
    .when().post("/getuserdata/")

    // then
    Response response = given().spec(requestSpecification())
        .body(jsonBody)
        .when().post("/getuserdata/")

通过使用 given().spec()，我们的代码现在变得简单多了。

结论

本文简单介绍了Rest Assured这个开源的接口测试框架是干嘛的，以及如何使用的，希望对大家有帮助。

以上就是Java基于Rest Assured自动化测试接口详解的详细内容，更多关于Java Rest Assured自动化测试接口的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

java、freemarker保留两位小数
这篇文章主要介绍了 java、freemarker保留两位小数的实现方法，然后给大家补充介绍了freemarker保留两位小数的详解,需要的朋友可以参考下
2017-03-03
OpenFeign服务接口调用的过程详解
Feign是一个声明式WebService客户端。使用Feign能让编写Web Service客户端更加简单。它的使用方法是定义一个服务接口然后在上面添加注解，这篇文章主要介绍了OpenFeign服务接口调用,需要的朋友可以参考下
2022-10-10
SpringBoot自定义全局异常处理器的问题总结
Springboot框架提供两个注解帮助我们十分方便实现全局异常处理器以及自定义异常,处理器会优先处理更具体的异常类型,如果没有找到匹配的处理器,那么它会寻找处理更一般异常类型的处理器,本文介绍SpringBoot自定义全局异常处理器的问题,一起看看吧
2024-01-01
Java与kotlin详细对比
这篇文章主要介绍了Java与kotlin详细对比,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-09-09
Java实现的最大匹配分词算法详解
这篇文章主要介绍了Java实现的最大匹配分词算法,简单说明了最大匹配分词算法的原理并结合具体实例形式最大匹配分词算法的实现方法与相关注意事项,需要的朋友可以参考下
2017-09-09
idea中如何全局搜索class文件或者字符串
这篇文章主要介绍了idea中如何实现全局搜索class文件或者字符串问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-03-03
Spring MVC的参数绑定和返回值问题
这篇文章主要介绍了Spring MVC的参数绑定和返回值问题，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2021-02-02
Java内存映射大文件轻松处理
这篇文章主要介绍了Java内存映射大文件轻松处理,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-08-08
Java数据导入功能之读取Excel文件实例
这篇文章主要介绍了Java数据导入功能之读取Excel文件实例,本文给出了jar包的下载地址以及读取Excel文件的代码实例,需要的朋友可以参考下
2015-06-06
Java设计模式之访问模式（Visitor者模式）介绍
这篇文章主要介绍了Java设计模式之访问模式（Visitor者模式）介绍,本文讲解了为何使用Visitor模式、如何使用Visitor模式、使用Visitor模式的前提等内容,需要的朋友可以参考下
2015-03-03