RestAssured -想要验证RestAssured中JSON响应的主体结构

Question

当我请求GET请求时，我得到了JSON响应，但这里我的要求是验证响应体的结构。

例如：

{
   "lotto":{
      "lottoId":5,
      "winning-numbers":[2,45,34,23,7,5,3],
      "winners":[
         {
            "winnerId":23,
            "numbers":[2,45,34,23,3,5]
         },
         {
            "winnerId":54,
            "numbers":[52,3,12,11,18,22]
         }
      ]
   }
}

上面的响应有结构，所以我需要验证结构而不是键值对，我如何实现？

Answer 1

最好的方法是验证json模式匹配。

首先，您需要将此依赖项添加到您的pom中.xml

<!-- https://mvnrepository.com/artifact/io.rest-assured/json-schema-validator -->
<dependency>
  <groupId>io.rest-assured</groupId>
  <artifactId>json-schema-validator</artifactId>
  <version>3.3.0</version>
  <scope>test</scope>
</dependency>

然后，您需要创建一个文件，其结构如下：

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "flow_id": {
            "type": "string",
            "minLength": 36,
            "maxLength": 36
          },
          "flow_org_id": {
            "type": "string"
          }
        },
        "required": [ "flow_id", "flow_org_id" ]
      }
    }
  }
}

有很多服务都是基于json生成模式的，例如，这一个

一旦模式文件准备好，您需要以字符串格式提供文件的路径-例如-

private static final String GET_SUBSCRIPTION_JSON_SCHEMA_PATH =
    "json/schemas/GetSubscriptionByIdSchema.json";

并调用matchesJsonSchemaInClasspath（"your/path/to/json-Schema"）方法进行断言。

UPD:

所以流程基本上是这样的：

• 您在项目目录中的某个位置有一个模式文件（并且知道它的路径）
• 您在某些测试方法中命中了endpoint
• 您将收到的响应与模式文件匹配

实际上，它将如下所示:

  @Test
  public void someTestMethod() {
    Response responseToValidate = // here you should assign and store returned response
    
    responseToValidate
      .assertThat()      
      .statusCode(200)
      .body("json.path.to.needed.key", equalTo("123"))

. body（匹配JsonSchemaInClasspath（"路径/到/你的/架构/在/字符串/格式"））；}