首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >Swagger UI中的多级(嵌套)标记

Swagger UI中的多级(嵌套)标记
EN

Stack Overflow用户
提问于 2017-01-23 14:22:43
回答 1查看 9.7K关注 0票数 7

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

目前,我正在使用API注解来标记每个@Api(tags = {"Heading1"})。生成的文档如下所示

代码语言:javascript
运行
复制
Tasks
--------->Heading1
          -------->Desc1
          --------->Desc2
---------->Heading2
          --------->Desc3
          --------->Desc4

我想在文档中添加一些副标题,这样看起来就像

代码语言:javascript
运行
复制
Tasks
--------->Heading1
          -------->Desc1
          --------->SubHeading1
                        --------->Desc2
---------->Heading2
          --------->SubHeading1
                     --------->Desc3 
          --------->SubHeading1
                     --------->Desc4

我该如何实现这一点?

EN

回答 1

Stack Overflow用户

发布于 2017-01-23 18:06:24

OpenAPI规范不支持嵌套标记。下面是相应的功能请求:

https://github.com/OAI/OpenAPI-Specification/issues/1367

您可以尝试通过将标记命名为tag1/tag2tag1.tag2tag1|tag2或类似的名称来模拟嵌套标记,但随后还必须修改工具以处理嵌套标记等名称。

Swagger UI用户请注意:有一个功能请求使用tag1|tag2或类似格式的标签名称来支持嵌套标签:

https://github.com/swagger-api/swagger-ui/issues/5969

票数 6
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/41800330

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档