用 SpringDoc 标签替换 SpringFox @Api 标签

Question

我有这个 SpringFox @Api 标签：

@Api(hidden = true)

我尝试将其替换为：

@Tag(hidden = true)

但是哪里没有选项hidded=true

替换它的正确方法是什么？

Answer 1

@Tag 注释上没有 hidden 属性，因为在面向 public 的 API 中有一个 API 没有多大意义25=] 但随后不将其包含在文档中。

建议的方法是将所有此类方法移动到它们自己的单独 class 中，而不是使用 @Tag 注释标记 class。然后你可以将 属性 springdoc.auto-tag-classes 设置为 false 这样 Springdoc 就不会在 default 标签中获取它。

如果您需要在标记有 @Tag 的 class 中包含 APIs，您应该使用 @Operation(hidden = true) 注释该方法并且应该隐藏该方法来自标签。