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

如果使用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"))));

您将最终得到两个片段目录,一个名为公司,另一个名为员工.然后,您可以使用每个的response-fields.adoc片段.

原始答案

当您记录请求或响应时,没有明确支持忽略字段,但我认为您可以通过使用预处理器删除您不想记录的字段来实现所需.

鉴于您想要分离文档,您可以记录公司名称和员工阵列.在第二步中,您需要预处理请求以删除公司,然后记录employees数组.

您的测试看起来像这样：

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

请注意在第二个文档调用中使用preprocessResponse. 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;
            }
        }

    });
}

您将最终得到两个片段目录,您可以使用每个的response-fields.adoc片段.

虽然上述方法有效,但它比它需要的更难.我已经打开了an issue,因此不再需要修改响应内容的预处理.