SpringBoot整合Swagger3的分组问题及解决

 更新时间:2026年06月14日 09:54:24   作者:y_bccl27  
这篇文章主要介绍了SpringBoot整合Swagger3的分组问题及解决过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

Swagger3如果没有设置分组

则所有的API接口全在一个default分组中,

如下所示:

如果功能模块和接口数量逐渐增多时

就会显得有些凌乱,不方便查找和使用,这时可提供的解决方法就是对API接口进行分组,配置多个分组只需要配置多个docket,并通过Swagger实例Docket的groupName()方法定义各个分组名

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger3Config {

    @Bean
    public Docket createRestApi1() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .groupName("User")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bc.work.controller.user"))
                .paths(PathSelectors.any())
                .build();
    }

    @Bean
    public Docket createRestApi2() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .groupName("Sys")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bc.work.controller.sys"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger3接口文档")
                .description("接口文档描述部分")
                .contact(new Contact("bc", "http://www.baidu.com", "123456@qq.com"))
                .version("1.0版本")
                .build();
    }
}

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 使用SSE流式输出实战记录(Javaweb前后端)

    使用SSE流式输出实战记录(Javaweb前后端)

    这篇文章主要介绍了使用SSE流式输出(Javaweb前后端)的相关资料,SSE是一种允许服务器向客户端推送实时数据的技术,适用于聊天应用、实时数据监控等场景,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-05-05
  • 阿里云发布 Spring Boot 新脚手架工程

    阿里云发布 Spring Boot 新脚手架工程

    这篇文章主要介绍了阿里云发布 Spring Boot 新脚手架的相关资料,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,可以参考下
    2020-04-04
  • java实现去除ArrayList重复字符串

    java实现去除ArrayList重复字符串

    本文主要介绍了java实现去除ArrayList重复字符串,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-09-09
  • Spring Bean创建的另一条捷径

    Spring Bean创建的另一条捷径

    这篇文章主要为大家介绍了Spring Bean创建的另一条方法捷径详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • SpringBoot整合 Quartz实现定时推送实战指南

    SpringBoot整合 Quartz实现定时推送实战指南

    文章介绍了Spring Boot中使用Quartz动态定时任务和任务持久化实现多条不确定结束时间并提前N分钟推送的方案,本文结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧
    2025-12-12
  • 参数校验Spring的@Valid注解用法解析

    参数校验Spring的@Valid注解用法解析

    这篇文章主要介绍了参数校验Spring的@Valid注解用法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • IDEA maven compile报错OutOfMemoryError(内存溢出)解决及jvm分析

    IDEA maven compile报错OutOfMemoryError(内存溢出)解决及jvm分析

    遇到Maven编译时报OutOfMemoryError错误通常因为默认的堆内存大小不足,本文就来介绍一下OutOfMemoryError(内存溢出)解决,具有一定的参考价值,感兴趣的可以了解一下
    2024-10-10
  • 简单实现Java通讯录系统

    简单实现Java通讯录系统

    这篇文章主要为大家详细介绍了如何简单实现Java通讯录系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-02-02
  • Java annotation元注解原理实例解析

    Java annotation元注解原理实例解析

    这篇文章主要介绍了Java annotation元注解原理实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • 用Java将字符串的首字母转换大小写

    用Java将字符串的首字母转换大小写

    在项目开发的时候会需要统一字符串的格式,比如首字母要求统一大写或小写,那用Java如何实现这一功能?下面一起来学习学习。
    2016-08-08

最新评论