Question

我开始使用Spring REST Docs来记录一个简单的REST API。我有一个具有某种层次结构的有效负载，例如像这样（有员工的公司）。

{
    "companyName": "FooBar",
    "employee": 
    [
        {
            "name": "Lorem",
            "age": "42"
        },

        {
            "name": "Ipsum",
            "age": "24"
        }
    ]
}

我想将公司对象（员工的姓名和数组）和员工对象（员工姓名和年龄）的文档分开。

使用解释here之类的org.springframework.restdocs.payload.PayloadDocumentation.responseFields强制我记录所有字段，但万一我只想记录员工字段 - 我该如何实现？

在没有员工详细信息的情况下记录公司没有问题，因为如果字段是文档，则后代也被视为已记录。但我不能单独记录员工结构，如果没有公司的根对象，我没有专门的有效负载。

Answer 1

受到这个问题的启发，我实施了一项增强功能，使原来的答案（见下文）过时了。

如果您使用1.0.0.BUILD-SNAPSHOT（可从https://repo.spring.io/libs-snapshot获得），您现在可以将字段标记为已忽略。已记录忽略的字段数，但实际上没有出现在文档中。

鉴于您要分离文档，有两个文档调用是有意义的。首先，您可以记录公司名称和员工阵列。在第二个中，您记录了employees数组并将公司名称标记为忽略。

您的测试看起来像这样：

mockMvc.perform(get("/company/5").accept(MediaType.APPLICATION_JSON))
        .andExpect(status().isOk())
        .andDo(document("company",
                responseFields(
                        fieldWithPath("companyName").description(
                                "The name of the company"),
                        fieldWithPath("employee").description(
                                "An array of the company's employees"))))
        .andDo(document("employee",
                responseFields(
                        fieldWithPath("companyName").ignored(),
                        fieldWithPath("employee[].name").description(
                                "The name of the employee"),
                        fieldWithPath("employee[].age").description(
                                "The age of the employee"))));

您最终会得到两个片段目录，一个名为company，另一个名为employee。然后，您可以使用每个response-fields.adoc代码段。

原始答案

当您记录请求或响应时，没有明确支持忽略字段，但我认为您可以通过使用预处理器删除您不想要的字段来实现您想要的效果。 39; t想要记录。

鉴于您要分离文档，有两个document调用是有道理的。首先，您可以记录公司名称和员工阵列。在第二步中，您需要预处理删除公司的请求，然后记录employees数组。

您的测试看起来像这样：

mockMvc.perform(get("/company/5").accept(MediaType.APPLICATION_JSON))
        .andExpect(status().isOk())
        .andDo(document("company",
                responseFields(
                        fieldWithPath("companyName").description(
                                "The name of the company"),
                        fieldWithPath("employee").description(
                                "An array of the company's employees"))))
        .andDo(document("employee",
                preprocessResponse(removeCompany()),
                responseFields(
                        fieldWithPath("employee[].name").description(
                                "The name of the employee"),
                        fieldWithPath("employee[].age").description(
                                "The age of the employee"))));

请注意在第二次preprocessResponse来电中使用document。 removeCompany返回一个预处理器，该预处理器使用自定义ContentModifier从响应中删除公司名称：

private OperationPreprocessor removeCompany() {
    return new ContentModifyingOperationPreprocessor(new ContentModifier() {

        @Override
        public byte[] modifyContent(byte[] originalContent, MediaType contentType) {
            ObjectMapper objectMapper = new ObjectMapper();
            try {
                Map<?, ?> map = objectMapper.readValue(originalContent, Map.class);
                map.remove("companyName");
                return objectMapper.writeValueAsBytes(map);
            }
            catch (IOException ex) {
                return originalContent;
            }
        }

    });
}

您最终会得到两个片段目录，一个名为company，另一个名为employee。然后，您可以使用每个response-fields.adoc代码段。

虽然上述方法有效，但比实际情况更难。我已经打开了an issue，因此不再需要修改回复内容的预处理。

使用Spring REST Docs记录分层JSON有效负载

1 个答案:

原始答案