软件测试专栏（15/20）：REST Assured接口自动化框架实战

本文导读：在Java生态中做接口自动化测试，REST Assured凭借其简洁的DSL语法和强大的验证能力，已成为事实标准。本文将带你从零掌握REST Assured的核心用法，理解如何构建可维护的接口测试框架，并将其集成到CI/CD流水线中。

一、为什么是REST Assured？

1.1 Java接口测试的困境

在Java中进行REST接口测试，传统方式是使用HttpURLConnection或HttpClient发送请求，再手动解析响应、编写断言。这种做法代码量大、重复性高、可读性差------一个简单的GET请求往往需要十几行代码才能完成。

REST Assured的出现改变了这一局面。它将Ruby和Groovy等动态语言中简洁的测试风格带入了Java生态，正如其官方文档所描述的："在Java中测试和验证REST服务比在Ruby和Groovy等动态语言中更难，REST Assured将这些语言的简洁性带入了Java领域。"

1.2 核心优势

REST Assured是一个用于简化REST API测试与验证的Java DSL（领域特定语言），它的核心优势体现在：

优势	说明
BDD风格语法	采用Given-When-Then模式，测试即文档，可读性强
丰富的验证能力	支持状态码、响应头、Cookie、JSON/XML响应体的全方位验证
灵活的数据提取	内置JSONPath和XmlPath，轻松从复杂响应中提取数据
多种认证机制	支持Basic、OAuth2、Digest等多种认证方式
请求日志	`log().all()`方法可打印详细日志，方便调试
开源活跃	版本持续更新，社区活跃

1.3 适用场景

REST Assured特别适合以下场景：

Java技术栈团队：与Maven/Gradle、JUnit/TestNG无缝集成
微服务接口测试：验证服务间调用的正确性
API回归测试：快速验证接口变更是否破坏现有功能
契约测试：作为消费者驱动契约测试的实施工具

二、快速上手

2.1 环境搭建

REST Assured通过Maven Central发布，在pom.xml中添加依赖即可：

xml 复制代码

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

配合TestNG或JUnit使用：

xml 复制代码

<dependency>
    <groupId>org.testng</groupId>
    <artifactId>testng</artifactId>
    <version>7.8.0</version>
    <scope>test</scope>
</dependency>

2.2 静态导入

为了写出简洁的测试代码，建议在测试类中静态导入以下类：

io.restassured.RestAssured.* ------ 核心API
io.restassured.matcher.RestAssuredMatchers.* ------ REST Assured匹配器
org.hamcrest.Matchers.* ------ Hamcrest匹配器（如equalTo、hasItems）

2.3 第一个测试

假设有一个返回JSON的接口/events?id=390，响应结构包含data.leagueId字段。用REST Assured验证该字段值的代码如下：

java 复制代码

@Test
public void verifyLeagueId() {
    get("/events?id=390")
        .then()
        .statusCode(200)
        .body("data.leagueId", equalTo(35));
}

这段代码的含义一目了然：发送GET请求，验证状态码为200，响应体中data.leagueId的值等于35。

同样的，验证数组中是否包含特定值也极为简洁：

java 复制代码

get("/events?id=390")
    .then()
    .body("odds.price", hasItems("1.30", "5.25"));

三、核心语法：Given-When-Then

REST Assured采用BDD风格的Given-When-Then模式，将测试分为三个阶段：

3.1 Given ------ 构建请求

在Given阶段设置请求的各种参数：

参数：queryParam()设置查询参数，pathParam()设置路径参数，formParam()设置表单参数
请求头 ：header("key", "value")设置Header
Cookie ：cookie("name", "value")设置Cookie
请求体 ：body(jsonString)设置JSON/XML请求体
认证：auth().basic(user, pass)设置Basic认证

3.2 When ------ 发送请求

指定HTTP方法和端点：

java 复制代码

.when()
.get("/users/{id}")

支持的HTTP方法包括GET、POST、PUT、DELETE、PATCH、OPTIONS、HEAD。

3.3 Then ------ 验证响应

在Then阶段验证响应结果：

状态码 ：statusCode(200)
响应头 ：header("Content-Type", "application/json")
响应体 ：body("path", equalTo(expected))
响应时间 ：time(lessThan(1000L))

3.4 完整示例

java 复制代码

@Test
public void createUserSuccessfully() {
    String requestBody = "{\"name\":\"New User\",\"email\":\"new@example.com\"}";
    
    given()
        .auth().basic("admin", "admin123")
        .header("Content-Type", "application/json")
        .body(requestBody)
    .when()
        .post("/users")
    .then()
        .statusCode(201)
        .body("id", notNullValue())
        .body("name", equalTo("New User"))
        .body("email", equalTo("new@example.com"));
}

四、响应验证详解

4.1 状态码验证

最基础的验证，确保接口可用：

java 复制代码

get("/api/orders").then().statusCode(200);

4.2 JSON响应体验证

REST Assured使用Groovy GPath语法访问JSON字段，支持深度嵌套的字段访问：

java 复制代码

// 验证单个字段值
get("/lotto").then().body("lotto.lottoId", equalTo(5));

// 验证字段不为空
get("/user/1").then().body("name", notNullValue());

// 验证数组长度
get("/users").then().body("size()", greaterThan(0));

// 验证数组包含特定值
get("/lotto").then().body("lotto.winners.winnerId", hasItems(23, 54));

// 验证数组中所有元素满足条件
get("/users").then().body("age", everyItem(greaterThan(18)));

4.3 响应头与Cookie验证

java 复制代码

get("/api/data")
    .then()
    .header("Content-Type", "application/json")
    .header("X-RateLimit-Remaining", Integer::parseInt, greaterThan(0))
    .cookie("session_id", notNullValue());

4.4 响应时间验证

java 复制代码

get("/api/search")
    .then()
    .time(lessThan(500L));  // 响应时间小于500ms

五、数据提取与复用

5.1 从响应中提取数据

有时需要提取响应数据供后续请求使用：

java 复制代码

// 提取单个值
String token = 
    given()
        .body(loginRequest)
    .when()
        .post("/login")
    .then()
        .extract()
        .path("token");

// 提取多个值（使用Response对象）
Response response = 
    given()
        .body(loginRequest)
    .when()
        .post("/login");
        
String token = response.path("token");
int userId = response.path("userId");

5.2 提取列表与对象

java 复制代码

// 提取ID列表
List<Integer> userIds = 
    get("/users")
    .then()
    .extract()
    .path("data.id");

// 提取嵌套字段列表
List<String> emails = 
    get("/users")
    .then()
    .extract()
    .path("data.findAll { it.active }.email");

5.3 请求规格复用

为避免重复配置，可以使用RequestSpecBuilder创建可复用的请求规格：

java 复制代码

RequestSpecification commonSpec = new RequestSpecBuilder()
    .setBaseUri("https://api.example.com")
    .setBasePath("/api/v1")
    .addHeader("Authorization", "Bearer " + token)
    .addHeader("Content-Type", "application/json")
    .build();

// 在多个测试中复用
given()
    .spec(commonSpec)
    .queryParam("page", 1)
.when()
    .get("/users")
.then()
    .statusCode(200);

六、认证机制

6.1 Basic认证

最简单的认证方式，适用于内部测试环境：

java 复制代码

given()
    .auth().basic("username", "password")
.when()
    .get("/secure/data")
.then()
    .statusCode(200);

6.2 OAuth2认证

微服务架构中最常用的认证方式：

java 复制代码

given()
    .auth().oauth2(accessToken)
.when()
    .get("/api/protected")
.then()
    .statusCode(200);

6.3 预请求认证

通过预请求获取Token后再执行主请求：

java 复制代码

String token = 
    given()
        .body("{\"username\":\"test\",\"password\":\"pass\"}")
    .when()
        .post("/auth/login")
    .then()
        .extract()
        .path("token");

given()
    .header("Authorization", "Bearer " + token)
.when()
    .get("/api/data")
.then()
    .statusCode(200);

七、与CI/CD集成

7.1 Maven + TestNG + REST Assured

REST Assured测试通常与Maven和TestNG（或JUnit）配合使用。通过Maven的maven-surefire-plugin在构建时自动执行测试。

7.2 Jenkins Pipeline配置

在Jenkins流水线中集成REST Assured测试：

groovy 复制代码

pipeline {
    agent any
    stages {
        stage('Checkout') {
            steps { checkout scm }
        }
        stage('Run API Tests') {
            steps {
                sh 'mvn clean test -DsuiteXmlFile=testng-api.xml'
            }
        }
        stage('Publish Report') {
            steps {
                publishHTML([
                    reportDir: 'target/surefire-reports',
                    reportFiles: 'index.html',
                    reportName: 'API Test Report'
                ])
            }
        }
    }
    post {
        always {
            junit 'target/surefire-reports/*.xml'
        }
    }
}

7.3 报告集成

REST Assured测试可以集成多种报告工具：

Allure：生成美观的可视化报告，含请求/响应详情
ExtentReports：生成HTML格式的详细测试报告
Jenkins JUnit插件：自动解析TestNG/JUnit生成的XML报告

八、最佳实践

实践	说明
统一Base URI	使用`RestAssured.baseURI`统一设置，避免硬编码
请求规格复用	用`RequestSpecBuilder`封装通用配置（认证、Header）
测试数据外部化	将测试数据放在JSON/YAML文件中，使用数据驱动测试
响应日志调试	调试时启用`log().all()`打印完整请求/响应
断言库统一	统一使用Hamcrest匹配器，保持代码风格一致
与CI/CD集成	将测试纳入流水线，每次构建自动执行
版本管理	锁定REST Assured版本，避免依赖升级导致的不稳定

在REST Assured中编写测试时，充分利用log().all()方法可以打印详细的请求和响应日志，这在接口测试出现问题后定位问题时非常有帮助。对于复杂的JSON响应验证，建议结合Json Schema Validator模块进行整体结构校验。

九、结语

REST Assured将Java接口测试从繁琐的底层HTTP操作中解放出来，让测试人员能够专注于业务逻辑的验证。其BDD风格的语法不仅降低了编写门槛，更让测试代码本身成为了一份可执行的API文档。

从单个接口测试到构建完整的接口自动化测试框架，REST Assured配合Maven、TestNG和Jenkins，可以形成一套高效、可维护的接口质量保障体系。

下一篇文章预告 ：视觉回归测试实践

我们将探索如何通过像素级对比，自动化发现UI样式和布局的异常变化。

附录：软件测试全栈实战专栏目录

序号	主题类别	文章标题	状态
1	基础概念	为什么需要软件测试？	已发布
2	测试类型	测试类型怎么选？UI测试、接口测试、白盒测试全解析	已发布
3	用例设计	测试用例设计艺术：等价类、边界值、场景法实战	已发布
4	缺陷管理	Bug的生命周期与管理：从发现到关闭的全流程	已发布
5	自动化基础	自动化测试入门指南	已发布
6	Web测试	Selenium实战从0到1：元素定位、等待机制、框架封装	已发布
7	接口测试	接口测试全攻略：Postman+Newman实现API自动化	已发布
8	移动测试	Appium移动自动化从入门到精通	已发布
9	性能测试	JMeter从入门到精通	已发布
10	安全测试	OWASP Top 10漏洞检测与防护	已发布
11	测试框架	pytest深度解析与插件体系	已发布
12	CI/CD集成	Jenkins流水线中的自动化测试	已发布
13	测试左移	测试左移：需求评审与测试策略	已发布
14	测试右移	测试右移：线上监控与故障排查	已发布
15	API测试进阶	REST Assured接口自动化框架实战	本文
16	视觉测试	视觉回归测试实践	待发布
17	测试平台	自动化测试平台搭建	待发布
18	质量效能	测试度量与团队效能	待发布
19	测试架构	企业级测试架构设计	待发布
20	职业发展	测试工程师成长路线与面试指南	待发布