Swagger 接口分组

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

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

 

解决方法：

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

    /**
     * 设置基础分组(包含所有注解标注过的接口)
     * @return
     */
    @Bean
    public 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
     */
    @Bean
    public 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 接口分组问题的一种解决方法，大体的解决方向是这样，具体的分组条件，可以根据自身项目实际进行最优选择尝试。