Swagger UI 中的多级（嵌套）标记

Question

我最近才开始研究 Swagger 2.0 API。我正在寻找一些组织 API 文档的方法。

目前我正在使用@Api(tags = {"Heading1"})Java 注释来标记每个 API。生成的文档看起来像

Tasks
--------->Heading1
          -------->Desc1
          --------->Desc2
---------->Heading2
          --------->Desc3
          --------->Desc4

我想在文档中添加一些副标题，使其看起来像

Tasks
--------->Heading1
          -------->Desc1
          --------->SubHeading1
                        --------->Desc2
---------->Heading2
          --------->SubHeading1
                     --------->Desc3 
          --------->SubHeading1
                     --------->Desc4

我如何实现这一目标？

Answer 1

OpenAPI 规范不支持嵌套标签。这是相应的功能请求：https :
//github.com/OAI/OpenAPI-Specification/issues/1367

您可以尝试通过命名标记以模拟嵌套的标签tag1/tag2，tag1.tag2，tag1|tag2或类似的，但你还不得不修改工具来处理这样的名字嵌套标签。

Swagger UI 用户注意：有一个功能请求支持使用表单tag1|tag2或类似标签名称的嵌套标签：https :
//github.com/swagger-api/swagger-ui/issues/5969