Swagger 接口分组

Swagger 默认只有一个 default 分组选项，如果没有设置，所有的接口都会显示在 default 分组下，如果功能模块和接口数量一多，就会显得有些凌乱，不方便查找和使用。

为了解决这个问题，今天上午花了些时间查找 Swagger 的接口分组设置办法，由于一开始思路和关键字设置不准备等原因，一时没找到正确满意的解决方案，直至看到大佬博客《swagger多个分组代码展示》才得以解决，特此记录下，以备不时之需。

解决方法：

首先找到你的 swagger 配置类(可以通过搜索 swagger 、@EnableSwagger2 等关键字)，然后在里面配置相应的分组代码，代码如下：

    /*** 设置基础分组(包含所有注解标注过的接口)* @return*/@Beanpublic Docket docketBase() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.demo.he")) .paths(PathSelectors.any())     //正则匹配请求路径，并分配至当前分组，当前所有接口.build().groupName("所有路径分组")      //分组名称.globalOperationParameters(setHeaderToken())
//                .ignoredParameterTypes(Demo.class);}/*** 设置demo2分组 - 匹配指定请求路径* @return*/@Beanpublic Docket docketDemo2() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.demo.he")).paths(PathSelectors.ant("/demo2/demo/**")) //正则匹配请求路径，并分配至当前分组.build().groupName("demo2分组")   //分组名称.globalOperationParameters(setHeaderToken())
//                .ignoredParameterTypes(Demo.class);}

代码配置完成后，重新启动项目，在 Swagger UI 主页面右上角下拉框中，即可看到分组，通过更改下拉框中的值，即可筛选出对应模块的接口。

上述配置代码和图片所示，当前设置了两个分组(所有路径分组和demo2分组)，代码中通过修改 .paths(PathSelectors.…) 中的内容，达到设置接口分组归属的目的。

而且，通过上述代码和图片可知，Swagger 中的接口是可以根据条件被重复分组的，即：如果接口 SWAGGER2测试被 dockBase() 方法设置过滤关联到所有路径分组中，还能被 docketDemo2() 方法设置过滤关联到分组 demo2分组中。

以上仅仅为接口分组的一种分组方法，通过设置 .paths() 接口请求路径的方式，还有其他的方法可以设置，比如根据 basePackage("包路径") 基础路径不同进行分组，还有 .paths(PathSelectors.regex()) 等等进行分组。

以上为解决 Swagger 接口分组问题的一种解决方法，大体的解决方向是这样，具体的分组条件，可以根据自身项目实际进行最优选择尝试。

Swagger 接口分组相关推荐

swagger接口文档分组
swagger接口文档分组解析问题因项目中的接口越来越多,使用swagger调试接口的时候,因接口太杂太乱,不太容易找到想要调试的接口,所以研究了一下swagger分组的方法但是分组是需要配置多 ...
基于 abp vNext 和 .NET Core 开发博客项目 - 再说Swagger，分组、描述、小绿锁
基于 abp vNext 和 .NET Core 开发博客项目 - 再说Swagger,分组.描述.小绿锁 https://github.com/Meowv/Blog 在开始本篇正文之前,解决一个 @ ...
swagger接口文档使用
swagger接口文档一,swagger简介前后端分离 swagger 诞生二,springboot集成swagger 依赖编写helloworld接口配置swagger ==> co ...
jeesite如何配置swagger_Spring Boot 2.x基础教程：Swagger接口分类与各元素排序问题详解...
之前通过Spring Boot 2.x基础教程:使用Swagger2构建强大的API文档一文,我们学习了如何使用Swagger为Spring Boot项目自动生成API文档,有不少用户留言问了关于文档 ...
swagger的分组注释
文章目录前言 swagger的分组注释总结前言关于swagger的分组注释提示:以下是本篇文章正文内容 swagger的分组注释通过配置两个Docket对Api文档进行分组,设置相关显示及 ...
sentinel 官方文档_SpringCloud网关聚合Swagger接口文档实践
目前大多数项目都是以微服务架构设计,以前后端分离技术解耦前端开发工程师和后端开发工程师的工作量,这样一来前后端的对接将是一项重要的沟通工作量,如果后端没有一个合适的API文档,那么这样的前后端对接将是 ...
springboot 接口文档请求 enum_Spring Boot集成SpringFox 3：生成Swagger接口文档
SpringFox介绍 SpringFox是一个开源的API Doc的框架, 它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现.官方定义为:Aut ...
整合Swagger接口文档
Swagger接口文档:自动生成接口文档 1.添加依赖: <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagg ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...

Swagger 接口分组

Swagger 接口分组相关推荐

最新文章

热门文章