3分钟搞定REST Assured测试框架：从依赖配置到接口验证全流程

3分钟搞定REST Assured测试框架：从依赖配置到接口验证全流程

【免费下载链接】rest-assured Java DSL for easy testing of REST services 项目地址: https://gitcode.com/gh_mirrors/re/rest-assured

你还在为REST API测试写冗长的HTTP客户端代码吗？还在为JSON响应解析烦恼吗？本文将带你零门槛搭建REST Assured测试框架，用极简代码实现接口自动化验证，读完你将掌握：

• 3行Maven依赖快速集成
• 5分钟完成基础配置
• 10行代码实现接口测试全流程
• 常见认证与响应验证技巧

框架简介与核心优势

REST Assured是一个专为REST API测试设计的Java领域特定语言（DSL），它让接口测试代码变得简洁易懂。相比传统的HttpClient+JSON解析的测试方式，REST Assured提供了声明式的API，使测试代码更具可读性和可维护性。

项目核心模块结构如下：

• 核心功能：rest-assured/
• JSON处理：json-path/
• XML处理：xml-path/
• 扩展支持：modules/（包含Kotlin/Scala扩展、Spring集成等）

环境准备与依赖配置

Maven依赖配置

在你的pom.xml中添加以下依赖，即可引入REST Assured核心功能：

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

如果需要JSON Schema验证或Spring集成等高级功能，可以添加相应模块：

<!-- JSON Schema验证 -->
<dependency>
    <groupId>io.rest-assured</groupId>
    <artifactId>json-schema-validator</artifactId>
    <version>5.5.7-SNAPSHOT</version>
    <scope>test</scope>
</dependency>

<!-- Spring MockMvc集成 -->
<dependency>
    <groupId>io.rest-assured</groupId>
    <artifactId>spring-mock-mvc</artifactId>
    <version>5.5.7-SNAPSHOT</version>
    <scope>test</scope>
</dependency>

所有模块版本已在父POM中统一管理：pom.xml

基础配置类

创建一个基础配置类，设置默认的请求参数和响应验证规则：

import io.restassured.RestAssured;
import io.restassured.config.LogConfig;
import io.restassured.config.RestAssuredConfig;
import org.junit.BeforeClass;

public class RestAssuredBase {
    @BeforeClass
    public static void setup() {
        // 设置默认基础URL
        RestAssured.baseURI = "https://api.example.com";
        // 配置日志输出
        RestAssured.config = RestAssuredConfig.config()
            .logConfig(LogConfig.logConfig().enableLoggingOfRequestAndResponseIfValidationFails());
        // 设置默认超时时间
        RestAssured.enableLoggingOfRequestAndResponseIfValidationFails();
    }
}

配置类主要使用了RestAssured.java和RestAssuredConfig.java中的核心API。

接口测试实战示例

GET请求与响应验证

以下示例展示如何发送GET请求并验证响应内容：

import io.restassured.RestAssured;
import static io.restassured.RestAssured.given;
import static org.hamcrest.Matchers.*;
import org.junit.Test;

public class GetApiTest extends RestAssuredBase {
    
    @Test
    public void testGetLotto() {
        given()
            .param("page", 1)
            .param("size", 10)
        .when()
            .get("/lotto")
        .then()
            .statusCode(200)
            .contentType("application/json")
            .body("lottoId", equalTo(5))
            .body("winners.winnerId", hasItems(23, 54))
            .body("winners.size()", greaterThan(0));
    }
}

代码解析：

• given()：设置请求参数
• when()：指定HTTP方法和URL
• then()：验证响应结果

POST请求与认证示例

使用基本认证发送POST请求：

@Test
public void testPostWithAuth() {
    given()
        .auth().basic("username", "password")
        .contentType("application/json")
        .body("{\"name\":\"test\",\"value\":\"123\"}")
    .when()
        .post("/resource")
    .then()
        .statusCode(201)
        .body("id", notNullValue())
        .body("name", equalTo("test"));
}

认证功能由AuthenticationScheme.groovy接口实现，支持Basic、Digest、OAuth等多种认证方式。

高级配置与最佳实践

请求规范复用

创建可复用的请求规范，减少重复代码：

import io.restassured.builder.RequestSpecBuilder;
import io.restassured.specification.RequestSpecification;

public class ApiSpecs {
    public static RequestSpecification apiRequestSpec() {
        return new RequestSpecBuilder()
            .setContentType("application/json")
            .addHeader("Accept", "application/json")
            .addHeader("X-API-Key", "your-api-key")
            .build();
    }
}

在测试中使用：

given()
    .spec(ApiSpecs.apiRequestSpec())
    .body("{\"key\":\"value\"}")
.when()
    .post("/endpoint")
.then()
    .statusCode(200);

请求规范构建器RequestSpecBuilder.java提供了丰富的配置方法。

响应提取与断言

提取响应数据进行复杂验证：

@Test
public void testExtractResponseData() {
    // 提取响应中的token
    String token = given()
        .body("{\"username\":\"test\",\"password\":\"pass\"}")
        .contentType("application/json")
    .when()
        .post("/login")
    .then()
        .statusCode(200)
        .extract()
        .path("token");
    
    // 使用提取的token进行后续请求
    given()
        .header("Authorization", "Bearer " + token)
    .when()
        .get("/user/profile")
    .then()
        .statusCode(200);
}

常见问题解决

依赖冲突处理

如果遇到Hamcrest或Jackson版本冲突，可在pom.xml中排除冲突依赖：

<dependency>
    <groupId>io.rest-assured</groupId>
    <artifactId>rest-assured</artifactId>
    <version>5.5.7-SNAPSHOT</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>

中文乱码问题

配置字符编码解决中文乱码：

RestAssured.config = RestAssuredConfig.config()
    .encoderConfig(EncoderConfig.encoderConfig()
    .defaultContentCharset("UTF-8"));

学习资源与进阶指南

官方提供了丰富的学习资源：

• 完整示例代码：examples/
• Kotlin扩展：modules/kotlin-extensions/
• Scala支持：modules/scala-support/
• Spring集成：modules/spring-mock-mvc/

建议按照以下路径进阶学习：

1. 基础API测试 → 2. 响应提取与验证 → 3. 测试套件组织 → 4. 持续集成集成

点赞收藏本文，关注获取更多REST Assured高级技巧，下期将分享"REST Assured与Allure报告集成"实战教程！

【免费下载链接】rest-assured Java DSL for easy testing of REST services 项目地址: https://gitcode.com/gh_mirrors/re/rest-assured