springdoc-openapi 中的隐藏参数不起作用

Question

我有 2.3.0 版的 Spring Boot 应用程序。 和 springdoc-openapi-webflux-ui 在 1.4.1 版本中。

我在这样的操作中有注释参数。

parameters = {
@Parameter(
    hidden = true, schema = @Schema(implementation = Boolean.class),
    in = ParameterIn.QUERY, name = DO_NOT_FORWARD
)

使用 hidden = true 我预计这个参数在 swagger-ui 中是不可见的。但它是。 是我误解了这个参数还是它没有做它应该做的事情？

我希望此参数在 api-docs 中，以生成能够使用此参数的客户端，但我希望它在 swagger-ui 中不可见

Answer 1

您只需确保@Parameter 注释中的名称是您要隐藏的操作参数的确切名称。

您也可以查看文档：

• https://springdoc.org/faq.html#how-can-i-hide-a-parameter-from-the-documentation-

如果您仍然遇到配置问题，您可以添加示例 HelloController 的代码来重现您的问题，或者您可以将链接添加到 github 中的一个最小的、可重现的示例。

Answer 2

试试

@Parameter(name = "paramName", hidden = true)
@GetMapping("/example")
public Object example(String paramName) {
    return null;
}

而不是

@Operation(
    parameters = {
        @Parameter(name = "paramName", hidden = true)
    }
)
@GetMapping("/example")
public Object example(String paramName) {
    return null;
}