量化接口-Swagger 接口分组_ 股票程序化软件自动交易接口

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)
                ;
    }

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