在POST API调用中处理JSON请求体的最佳实践

什么是POST请求？

POST请求是一种HTTP方法，用于将数据发送到服务器以进行进一步处理。与GET请求主要用于从服务器检索数据不同，POST请求通常用于向服务器提交数据，例如输入表单或JSON对象。

在发出POST请求时，数据会包含在请求的正文中，通常以JSON格式的键值对形式发送。请求头中的Content-Type字段指定了数据的格式，例如：

application/x-www-form-urlencoded：用于表单数据
application/json：用于JSON数据

服务器在接收到POST请求后，会处理数据，并返回一个HTTP响应，指示操作的状态。

POST请求的示例

以下是一个POST请求的示例。在该请求中，我们希望通过在请求正文中提供必要的值，在服务器上创建一个新的资源。服务器会根据提供的信息创建资源，并将响应返回给客户端。

执行此脚本后，服务器返回了以下响应，表示操作成功，响应代码为201。

在上述请求中，我们直接将资源的值传递到请求体中。如果需要使用相同的测试发送多个请求，该如何实现呢？接下来，我们将探讨如何实现这一目标。

参数化请求正文

为了使API调用更具动态性和灵活性，我们可以对请求正文进行参数化。这种方法允许我们在不修改请求结构的情况下，为不同场景发送不同的数据值。

参数化的优势

代码可重用性：减少重复代码，提高开发效率。
可维护性：更容易维护和更新代码。
灵活性：能够根据不同的用例定制API请求。

动态传递值

我们可以创建一个类来包含请求正文，并通过动态传递值来替换正文中的特定变量。例如，通过调用RequestPayload类中的addResource()方法，将动态值传递到请求正文中。

使用TestNG的DataProvider实现参数化

在TestNG中，@DataProvider注解用于为参数化测试提供数据。它允许从多种来源（如数组、Excel文件、数据库等）提供测试数据。@DataProvider方法返回一个对象数组，其中每个对象代表一组测试数据。

示例代码

以下是一个使用@DataProvider实现参数化的示例代码：

public class PostRequestDetails {

    @org.testng.annotations.Test(dataProvider = "ResourceData")
    public void addResources(String title, int id) {
        ValidatableResponse response;
        RestAssured.baseURI = "https://jsonplaceholder.typicode.com";
        response = RestAssured.given().contentType("application/json")
            .body(RequestPayload.addResource(title, id))
            .when().post("/posts").then();
        response.statusCode(201).log().all();
    }    @DataProvider(name="ResourceData")
    public Object[][] getData() {
        return new Object[][] {
            {"Story1", 1},
            {"Story2", 2},
            {"Story3", 3},
            {"Story4", 4}
        };
    }
}

代码解析

@DataProvider注解：定义一个数据提供者方法getData()，返回一个二维数组，每一行代表一组测试数据。
@Test注解：测试方法addResources()使用dataProvider属性指定数据提供者的名称。
动态数据传递：通过RequestPayload.addResource()方法，将动态值传递到请求正文中。

注意事项

测试方法中的参数数量必须与数据提供者提供的参数数量完全匹配。
数据提供者名称需要与@Test注解中的dataProvider属性一致。

总结

本文深入探讨了POST JSON等常见数据格式构建请求，并探讨了如何使用TestNG的@DataProvider注解实现请求正文的参数化。

通过参数化请求正文，我们可以动态地为API请求提供数据，从而提高代码的灵活性和可维护性。这种方法特别适用于需要使用不同数据集运行相同测试的场景。

希望本文对您有所帮助！

原文链接: https://medium.com/@guptadiksha88/best-practices-for-handling-json-request-bodies-in-post-api-calls-1b19fc6a8da7