Question

我有一棵返回以下结构的树：

[{
 "data":
  {
      "id": 15,
      "permissionId": "perm1",
      "name": "Events"
  },
  "children": [
  {
      "data":
      {
          "id": 16,
          "permissionId": "perm2",
          "name": "Report",
          "parentRightDictionaryItemId": 15
      },
      "children": [
      {
          "data":
          {
              "id": 17,
              "permissionId": "perm3",
              "name": "Construct",
              "parentRightDictionaryItemId": 16
          }
      }],

  }]

}]

我不理解如何记录这棵树的字段，因为它可能很深。我正在尝试执行的操作，此函数返回已记录字段的结构：

protected List<FieldDescriptor> getResponseFieldDescriptor(String prefix) {
    List<FieldDescriptor> fields = new ArrayList<>();

    fields.add(fieldWithPath(prefix + "data").description("data").type(OBJECT));
    fields.add(fieldWithPath(prefix + "data.id").description("id").type(NUMBER));
    fields.add(fieldWithPath(prefix + "data.permissionId").description("permissionId").type(STRING));
    fields.add(fieldWithPath(prefix + "data.name").description("name").type(STRING));
    fields.add(fieldWithPath(prefix + "children").description("children").type(ARRAY).optional());  // I want this to be enough, but that's not enough

    return fields;
}

如果子级为空，则我的函数可以正常工作。但是在有孩子的情况下，返回一个错误，我没有记录整个树结构。好多怎么办？

Answer 1

如果您只想记录响应的一部分并且不希望测试在未记录的部分上失败，那么我会看到至少两种方法。响应的一部分可以用subsectionWithPath记录下来：

如果您不想提供所有字段的详细文档，则可以记录有效载荷的整个子部分。

一种替代方法是使用relaxedResponseFields：

字段也可以宽松模式记录，其中任何未记录的字段都不会导致测试失败。为此，请在org.springframework.restdocs.payload.PayloadDocumentation上使用relaxedRequestFields和relaxedResponseFields方法。

有关更多详细信息，请参见https://docs.spring.io/spring-restdocs/docs/2.0.3.RELEASE/reference/html5/#documenting-your-api-request-response-payloads-fields。

如何在Spring REST Docs中记录树

1 个答案: