【问题标题】:How to define a global Tag for OpenAPI 3 Spring Doc如何为 OpenAPI 3 Spring Doc 定义全局标签
【发布时间】:2021-10-18 16:32:02
【问题描述】:

我使用 spring-doc 来生成开放的 api 文档,但是默认情况下它使用控制器名称作为标签。我知道我可以用@Tag 注释覆盖它,但是有没有办法为所有控制器全局执行它,而不是一个一个地定义每个控制器上的标签,特别是因为我希望所有控制器都用项目名称标记?

【问题讨论】:

  • 您的控制器是否跨越多个类?你能分享一张你现在得到的确切输出的图像吗?此外,共享一个示例控制器/类(类似于您所拥有的)将有助于突出您当前的操作方式。
  • 是的,确实如此!我有多个控制器用于不同的用例,并希望它们都具有相同的标签,因为然后我使用文档为其他服务生成客户端。

标签: spring-boot springdoc


【解决方案1】:

我尚未对此进行测试,但我希望您需要使用 OpenAPIDefinition.tags() 以编程方式执行此操作。至少接口 Tag 上的文档说明如下:

也可以在 OpenAPIDefinition.tags() 中使用来定义规范级别的标签。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2019-11-07
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-11-26
    相关资源
    最近更新 更多