我最近才开始开发Swagger 2.0API。我正在寻找一些方法来组织API文档。
目前,我正在使用API注解来标记每个@Api(tags = {"Heading1"})
。生成的文档如下所示
Tasks
--------->Heading1
-------->Desc1
--------->Desc2
---------->Heading2
--------->Desc3
--------->Desc4
我想在文档中添加一些副标题,这样看起来就像
Tasks
--------->Heading1
-------->Desc1
--------->SubHeading1
--------->Desc2
---------->Heading2
--------->SubHeading1
--------->Desc3
--------->SubHeading1
--------->Desc4
我该如何实现这一点?
发布于 2017-01-23 18:06:24
OpenAPI规范不支持嵌套标记。下面是相应的功能请求:
https://github.com/OAI/OpenAPI-Specification/issues/1367
您可以尝试通过将标记命名为tag1/tag2
、tag1.tag2
、tag1|tag2
或类似的名称来模拟嵌套标记,但随后还必须修改工具以处理嵌套标记等名称。
Swagger UI用户请注意:有一个功能请求使用tag1|tag2
或类似格式的标签名称来支持嵌套标签:
https://stackoverflow.com/questions/41800330
复制相似问题