请问 Swagger 支持对接口进行多级分组么

2019-11-23 17:59:30 +08:00
 bwangel

前言

刚刚体验了一下 Swagger,感觉用它来生成项目的文档以及测试接口确实很方便。但感觉把它用在大项目上,似乎有些麻烦。

疑问

看了一下 httpbin 的例子,Swagger 似乎只支持对接口进行一级分组(HTTP Method 一组,Auth一组,等等)。

请问 Swagger 可以支持多级分组么?例如 论坛模块 是一组,论坛模块 下面又分为 帖子模块, 文章模块 等,然后这些子模块中各自有若干个接口。

同时在 SwaggerUI (或其他查看工具)中, 每组接口各自有一个页面,而 不是把所有接口堆在一个页面中 ,感觉如果 4 5 百个接口同时在一个页面中,那样在 SwaggerUI 中查看起来太麻烦了。

2940 次点击
所在节点    程序员
6 条回复
Trim21
2019-11-23 18:07:20 +08:00
应该是不能吧。当初我也想这么干,然后发现一个接口添加两个 tag 之后甚至会在两个 tag 里面重复显示
bwangel
2019-11-23 19:10:01 +08:00
@Trim21 好吧。。那感觉在大项目中没法统一用啊,只能模块维护一份自己的 Swagger.yaml 文件。
Muninn
2019-11-23 23:38:10 +08:00
右上角可以切换配置啊,你把这个当做第一级就好了。
bwangel
2019-11-24 00:32:41 +08:00
Muninn
2019-11-24 22:31:36 +08:00
不用输入,启动 swagger 的配置选项里可以配置多个配置文件,还可以给配置文件起名字。

总之我的界面和你不太一样,我用的是官方出的 docker 版 ui,然后用 ci 自动生成若干配置文件。
Muninn
2019-11-24 22:32:21 +08:00
我的右上角就是一个下拉列表,没有那个按钮。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/622452

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX