Rest-Assured PUT请求中Hamcrest断言失败的排查与解决

Rest-Assured与Hamcrest断言基础

在api自动化测试中，rest-assured是一个功能强大的java库，用于简化restful服务的测试。它提供了简洁的dsl（领域特定语言），使得发送http请求、接收响应以及验证响应内容变得直观。hamcrest是java中常用的匹配器库，与rest-assured结合使用时，可以实现灵活且富有表现力的断言，例如验证响应状态码、响应头或响应体中的特定字段值。

通常，一个完整的API测试流程包括：

1. 设置请求参数： 包括Base URI、路径参数、查询参数、请求头和请求体。
2. 发送请求： 使用GET、POST、PUT、DELETE等HTTP方法。
3. 接收响应： 获取服务器返回的响应。
4. 验证响应： 使用断言检查响应的状态码、头部信息和响应体内容是否符合预期。

遇到的问题：PUT请求的JSON解析异常

在使用Rest-Assured进行API测试时，有时会遇到一个看似矛盾的问题：PUT请求返回了HTTP 200 OK状态码，但在尝试对响应体进行Hamcrest断言时，却抛出了java.lang.IllegalArgumentException: The JSON input text should neither be null nor empty.异常。这通常发生在代码中包含类似body("msg", equalTo("Address successfully updated"))这样的断言时。

import io.restassured.RestAssured;
import io.restassured.path.json.JsonPath;
import static io.restassured.RestAssured.*;
import static org.hamcrest.Matchers.*;

public class Basics {

    public static void main(String[] args) {
        RestAssured.baseURI = "https://rahulshettyacademy.com";

        // ... (POST请求部分，此处省略以聚焦PUT问题)

        // 假设通过POST请求获取了place_id
        String place_id = "e50a637ebdf651c6808204513eedadd1"; // 示例place_id

        // 存在问题的PUT请求
        given().log().all().queryParam("key","qaclick123")
                .header("Content-Type","application/json")
                .body("{\n" +
                        "\"place_id\":\""+place_id+"\",\n" +
                        "\"address\":\"70 Summer walk, USA\",\n" +
                        "\"key\":\"qaclick123\"\n" +
                        "}")
                .when().put("/maps/api/place/add/json") // 注意：这里是问题所在
                .then().log().all().assertThat()
                .statusCode(200).body("msg",equalTo("Address successfully updated")); // 在此行抛出异常
    }
}

异常信息The JSON input text should neither be null nor empty.表明Rest-Assured在尝试解析响应体为JSON时失败了，因为它发现响应体为空或不是有效的JSON格式。尽管HTTP状态码是200 OK，这通常意味着请求成功，但响应体内容却不符合JSON解析器的预期。

问题根源分析：错误的API端点

这种现象的根本原因往往在于PUT请求使用了错误的API端点（URL路径）。在RESTful API设计中，不同的HTTP方法（POST、PUT、GET等）通常对应不同的资源路径或对同一资源执行不同的操作。

在上述示例中，POST /maps/api/place/add/json用于“添加”位置。而“更新”位置的操作，根据API设计规范，通常会使用PUT方法，但其对应的URL路径应该是一个专门用于更新的端点，例如/maps/api/place/update/json。

当PUT请求发送到/maps/api/place/add/json时，服务器可能：

1. 返回200 OK但空响应体： 服务器可能识别出这是一个PUT请求到“添加”端点，认为这种组合是无效的或不被支持的，但为了兼容性或简化处理，仍返回200 OK，但响应体为空或只包含非JSON格式的信息。
2. 返回200 OK但非预期响应体： 服务器可能将此请求视为一种特殊情况，并返回一个不包含msg字段或根本不是JSON的响应。

Rest-Assured在接收到这样的响应后，当执行body("msg", equalTo("Address successfully updated"))时，会尝试将响应体解析为JSON。如果响应体为空或不是有效的JSON，JsonPath解析器就会抛出IllegalArgumentException。

Tellers AI

Tellers是一款自动视频编辑工具，可以将文本、文章或故事转换为视频。

78

查看详情

解决方案：修正API端点

解决此问题的关键是确保PUT请求指向正确的API端点。根据API文档，用于更新（update）位置的PUT请求的正确URL应该是：

https://rahulshettyacademy.com/maps/api/place/update/json?key=qaclick123

将代码中的PUT请求URL从/maps/api/place/add/json修改为/maps/api/place/update/json即可。

import io.restassured.RestAssured;
import io.restassured.path.json.JsonPath;
import static io.restassured.RestAssured.*;
import static org.hamcrest.Matchers.*;

public class Basics {

    public static void main(String[] args) {
        RestAssured.baseURI = "https://rahulshettyacademy.com";

        // ... (POST请求部分，此处省略以聚焦PUT问题)

        // 假设通过POST请求获取了place_id
        String place_id = "e50a637ebdf651c6808204513eedadd1"; // 示例place_id

        // 修正后的PUT请求
        given().log().all().queryParam("key","qaclick123")
                .header("Content-Type","application/json")
                .body("{\n" +
                        "\"place_id\":\""+place_id+"\",\n" +
                        "\"address\":\"70 Summer walk, USA\",\n" +
                        "\"key\":\"qaclick123\"\n" +
                        "}")
                .when().put("/maps/api/place/update/json") // **已修正的端点**
                .then().log().all().assertThat()
                .statusCode(200).body("msg",equalTo("Address successfully updated"));
    }
}

通过这一修改，PUT请求将被发送到预期的更新端点，服务器将返回正确的JSON响应体（例如{"msg":"Address successfully updated"}），从而使Hamcrest断言能够成功解析并验证响应内容。

注意事项与最佳实践

1. 仔细查阅API文档： 在进行API测试时，始终将API文档作为第一参考。它会明确指出每个端点支持的HTTP方法、请求参数、请求体格式以及预期的响应结构。
2. 区分增删改查操作：
   • POST： 通常用于创建新资源。
   • PUT： 通常用于完全替换现有资源。
   • PATCH： 通常用于部分更新现有资源。
   • GET： 用于获取资源。
   • DELETE： 用于删除资源。 确保你的测试代码中使用的HTTP方法和端点与API的预期行为严格匹配。
3. 利用log().all()调试： Rest-Assured的log().all()方法在请求和响应链中非常有用。它会打印出完整的请求信息和响应信息（包括状态码、头部和响应体），这对于调试API问题至关重要。当断言失败时，首先检查log().all()输出的实际响应体，看它是否为空、格式错误或不包含预期字段。
4. 逐步构建断言： 当遇到复杂的API响应时，可以先从简单的断言开始（例如只断言状态码），确认请求和基本响应无误后，再逐步添加对响应体内容的详细断言。
5. 处理非JSON响应： 如果API在某些情况下可能返回非JSON格式的响应（例如纯文本、HTML或空响应），并且你仍然需要对其进行断言，则需要调整断言策略，例如使用extract().response().asString()获取原始响应体，然后进行字符串匹配，而不是直接使用body()方法进行JSON路径断言。

总结

IllegalArgumentException: The JSON input text should neither be null nor empty.在Rest-Assured的Hamcrest断言中，特别是当HTTP状态码为200 OK时，是一个常见的误导性错误。它通常不是因为JSON解析器本身的问题，而是因为API请求的URL路径与HTTP方法不匹配，导致服务器返回了非预期的空或非JSON格式的响应体。通过仔细核对API文档，确保使用正确的API端点和HTTP方法，可以有效避免此类问题，并提高API自动化测试的准确性和稳定性。

以上就是Rest-Assured PUT请求中Hamcrest断言失败的排查与解决的详细内容，更多请关注php中文网其它相关文章！