10

我最近才开始研究 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

我如何实现这一目标？

4

1 回答 1

7

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

于 2017-01-23T10:06:23.723 回答