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

Question

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

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

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中最小的可复制示例中。