spring-boot - 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(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;
}