4

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

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

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

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

使用此处org.springframework.restdocs.payload.PayloadDocumentation.responseFields解释的类似内容会强制我记录所有字段，但如果我只想记录员工字段 - 我该如何实现？

我可以在没有员工详细信息的情况下记录公司，因为如果一个字段是文档，则后代也被视为已记录。但是我无法单独记录员工结构，并且在没有公司根对象的情况下，我没有此结构的专用有效负载。

4

1 回答 1

8

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

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

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

您的测试将如下所示：

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每个片段。

原始答案

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

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

您的测试将如下所示：

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每个片段。

虽然上述方法可行，但它比需要的更难。我已经打开了一个问题，以便不再需要修改响应内容的预处理。

于 2015-09-30T15:35:15.500 回答