如何以及在何处使用 Spring Auto REST Docs 中的 failOnUndocumentedParams？

Question

我正在使用 Spring Auto REST Docs，想知道 failOnUndocumentedParams 的使用，以及如何使用它。我希望如果我错过了 POJO 中的某个字段，则不应生成该文档。我相信使用 failOnUndocumentedParams 是我的解决方案。但是，我不知道如何以及在哪里使用它。

@Before
public void setUp() throws IOException {

    mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext)
                .alwaysDo(JacksonResultHandlers.prepareJackson(objectMapper))
                .alwaysDo(MockMvcRestDocumentation.document("{class-name}/{method-name}",

                        Preprocessors.preprocessRequest(),
                        Preprocessors.preprocessResponse(
                                ResponseModifyingPreprocessors.replaceBinaryContent(),
                                ResponseModifyingPreprocessors.limitJsonArrayLength(objectMapper),
                                Preprocessors.prettyPrint())))
                .apply(MockMvcRestDocumentation.documentationConfiguration(this.restDocumentation)
                        .uris()
                        .withScheme("http")
                        .withHost("localhost")
                        .withPort(8080)
                        .and().snippets()

                        .withDefaults(CliDocumentation.curlRequest(),
                                HttpDocumentation.httpRequest(),
                                HttpDocumentation.httpResponse(),
                                AutoDocumentation.requestFields(),
                                AutoDocumentation.responseFields(),
                                AutoDocumentation.pathParameters(),
                                AutoDocumentation.requestParameters(),
                                AutoDocumentation.description(),
                                AutoDocumentation.methodAndPath(),
                                AutoDocumentation.section()))
                .build();
}

这是我的 mockMvc 的样子。

Answer 1

您可以在创建请求或响应字段片段时配置该功能。在您的情况下，您希望为所有测试启用该功能，因此在设置 Mock MVC 时：

.withDefaults(
    ...
    AutoDocumentation.requestFields().failOnUndocumentedFields(true),
    AutoDocumentation.responseFields().failOnUndocumentedFields(true),
    ...)

或者可以为单个测试启用该功能：

document("some-path",
    AutoDocumentation.requestFields().failOnUndocumentedFields(true),
    AutoDocumentation.responseFields().failOnUndocumentedFields(true))

如何以及在何处使用 Spring Auto REST Docs 中的 failOnUndocumentedParams？

How and Where to use failOnUndocumentedParams in Spring Auto REST Docs?

mockmvc

spring-auto-restdocs