SpringBoot整合Swagger2/Swagger3之拦截器配置方式

 更新时间:2026年06月29日 09:24:33   作者:Ju3tinZ2  
这段文章详细介绍了Springfox Swagger 3.0的配置方法,包括前端资源路径设置和POM依赖配置,并提供了AntPath路径匹配规则说明,帮助大家更好地理解和应用Swagger文档生成

1. swagger2.0

1.1 POM依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

1.2 Swagger设置

@Configuration
// 关键
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestAPI() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 改为自己的controller包路径
                .apis(RequestHandlerSelectors.basePackage("xx.xx.xx.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("WebNovel接口文档")
                .description("WebNovel Restful 接口")
                .contact(new Contact("xxUser", "#", "xxUser@.qq.com"))
                .version("1.0")
                .build();
    }
}

1.3 拦截器排除

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {

    // 请求路径排除
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor()
            .addPathPatterns("/**")
            .excludePathPatterns("/swagger-resources/**")
            .excludePathPatterns("/webjars/**")
            .excludePathPatterns("/v2/**")
            .excludePathPatterns("/swagger-ui.html/**");
        super.addInterceptors(registry);
    }

    // 资源映射增加
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }
}

2. swagger3.0

swagger3.0前端资源路径在springfox-swagger-ui-3.0.0.jar包中。

具体路径:META-INF\resources\webjars\springfox-swagger-ui

2.1 POM依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

2.2 Swagger设置

@Configuration
// 关键
@EnableOpenApi
public class SwaggerConfig {

    @Bean
    public Docket createRestAPI() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("xx.xx.xx.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("WebNovel接口文档")
                .description("WebNovel Restful 接口")
                .contact(new Contact("xxUser", "#", "xxUser@qq.com"))
                .version("1.0")
                .build();
    }
}

2.3 拦截器排除

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/swagger-ui/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/");
        super.addResourceHandlers(registry);
    }

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor()
                .addPathPatterns("/**")
                .excludePathPatterns("/swagger**/**")
                .excludePathPatterns("/webjars/**")
                .excludePathPatterns("/v3/**")
                .excludePathPatterns("/doc.html");
        super.addInterceptors(registry);
    }
}

3. Ant Path匹配规则

说明:

WildcardDescription
?匹配任意单个字符
*匹配0或多个字符
**匹配0或多级目录

例子:

PathDescription
/api/**app路径下所有路径
/**/*.html任意html文件
/my*/***my开头的路径下的所有路径

总结

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

相关文章

  • SpringBoot中使用redis做分布式锁的方法

    SpringBoot中使用redis做分布式锁的方法

    这篇文章主要介绍了SpringBoot中使用redis做分布式锁的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-09-09
  • Java异常日志堆栈丢失的原因与排查

    Java异常日志堆栈丢失的原因与排查

    这篇文章主要给大家介绍了关于Java异常日志堆栈丢失的原因与排查的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • Redis使用RedisTemplate模板类的常用操作方式

    Redis使用RedisTemplate模板类的常用操作方式

    这篇文章主要介绍了Redis使用RedisTemplate模板类的常用操作方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • JVM虚拟机的类加载机制详解

    JVM虚拟机的类加载机制详解

    这篇文章主要介绍了JVM虚拟机的类加载机制详解,类是在运行期间第一次使用时动态加载的,而不是一次性加载所有类,因为如果一次性加载,那么会占用很多的内存,需要的朋友可以参考下
    2023-12-12
  • Java优秀测试框架TestNG详解

    Java优秀测试框架TestNG详解

    这篇文章主要为大家详细介绍了Java优秀测试框架TestNG,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-02-02
  • MyBatis中example.createCriteria()方法的具体使用

    MyBatis中example.createCriteria()方法的具体使用

    本文详细介绍了MyBatis的Example工具的使用方法,包括链式调用指定字段、设置查询条件、支持多种查询方式等,还介绍了mapper的crud方法、and/or方法的使用,以及如何进行多条件和多重条件查询,感兴趣的可以了解一下
    2024-10-10
  • 为IntelliJ IDEA配置JVM参数的两种方法

    为IntelliJ IDEA配置JVM参数的两种方法

    在使用IntelliJ IDEA进行Java开发时,合理配置JVM参数对于优化项目性能和资源管理至关重要,IntelliJ IDEA提供了两种方便的方式来设置JVM参数,本文将详细介绍这两种方法:通过工具栏编辑配置和通过服务编辑配置,需要的朋友可以参考下
    2024-12-12
  • Java锁之自旋锁详解

    Java锁之自旋锁详解

    这篇文章主要介绍了Java锁之自旋锁详解,本文是系列文章的第一篇,请持续关注脚本之家java栏目,需要的朋友可以参考下
    2014-09-09
  • Springboot使用filter对response内容进行加密方式

    Springboot使用filter对response内容进行加密方式

    这篇文章主要介绍了Springboot使用filter对response内容进行加密方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Drools Fusion(CEP)定义及使用方法讲解

    Drools Fusion(CEP)定义及使用方法讲解

    今天小编就为大家分享一篇关于Drools Fusion(CEP)定义及使用方法讲解,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-03-03

最新评论