SpringBoot整合Swagger页面禁止访问swagger-ui.html方式

 更新时间:2025年02月08日 10:02:14   作者:费曼乐园  
本文介绍了如何在SpringBoot项目中通过配置SpringSecurity和创建拦截器来禁止访问SwaggerUI页面,此外,还提供了禁用SwaggerUI和Swagger资源的配置方法,以确保这些端点和页面对外部用户不可见或无法访问

SpringBoot整合Swagger页面禁止访问swagger-ui.html

在Spring Boot中禁止访问Swagger UI页面并在拦截器中进行拦截可以通过配置Spring Security来实现。

下面是一个简单的示例,演示如何实现这一点:

在Spring Boot项目中创建一个Spring Security配置类

如下所示:

import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .antMatchers("/swagger-ui.html").denyAll()
            .antMatchers("/swagger-resources/**").permitAll() // 如果需要访问Swagger的其他资源,可以放行
            .and()
            .csrf().disable();
    }
}

在这个配置中,我们使用HttpSecurity对象配置了访问规则。

  • .antMatchers("/swagger-ui.html").denyAll() 表示禁止访问 swagger-ui.html 页面
  • .antMatchers("/swagger-resources/**").permitAll() 则允许访问Swagger的其他资源

创建一个拦截器(Interceptor)类

用于拦截对 swagger-ui.html 的访问:

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (request.getRequestURI().equals("/swagger-ui.html")) {
            response.setStatus(HttpServletResponse.SC_FORBIDDEN);
            return false;  // 拦截访问
        }
        return true;  // 放行其他请求
    }
    
    // 可以实现 postHandle 和 afterCompletion 方法进行相应处理
}

配置这个拦截器类并使其生效:

import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor());
    }
}

这样配置后,即可通过Spring Security和拦截器实现禁止访问Swagger UI页面 swagger-ui.html

如果你想完全禁用Swagger UI和Swagger资源

你可以在 Spring Boot 项目的 application.ymlapplication.properties 文件中添加以下配置来实现:

  • application.yml 文件中的配置:
spring:
  profiles: 
  swagger:
    enabled: false
  • application.properties 文件中的配置:
spring.profiles.swagger.enabled=false

通过将这些配置设置为 false,你可以完全禁用 Spring Boot 中关于 Swagger UI 和 Swagger 资源的自动配置和展示。

这样就可以确保这些端点和页面对外部用户不可见或无法访问。

总结

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

相关文章

  • JAVA中值类型和引用类型的区别

    JAVA中值类型和引用类型的区别

    在java开发中经常会遇到值类型和引用类型知识,但是有很多朋友不清楚java中值类型和引用类型的区别,今天小编通过本文给大家介绍下
    2017-02-02
  • SpringBoot项目启动后自动加载系统配置的多种实现方式

    SpringBoot项目启动后自动加载系统配置的多种实现方式

    这篇文章主要介绍了SpringBoot项目启动后自动加载系统配置的多种实现方式,并通过代码示例讲解的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2025-01-01
  • Mybatis的Cursor避免OOM异常的方法详解

    Mybatis的Cursor避免OOM异常的方法详解

    在Mybatis中,有一个特殊的对象Cursor,这个对象的注释上清晰的说明了,这个类的用途,在Mybatis中使用Cursor非常简单,只要在Mapper文件中将方法的返回值设置成Cursor<T>即可,本文给大家介绍了Mybatis的Cursor避免OOM异常的方法,需要的朋友可以参考下
    2024-06-06
  • Java 使用keytool创建CA证书的操作

    Java 使用keytool创建CA证书的操作

    这篇文章主要介绍了Java 使用keytool创建CA证书的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • java实现租车系统

    java实现租车系统

    这篇文章主要为大家详细介绍了java实现租车系统,以及遇到的两个问题解决方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-01-01
  • Mybatis中#{}与${}的区别详解

    Mybatis中#{}与${}的区别详解

    这篇文章主要介绍了Mybatis中#{}与${}的区别详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-12-12
  • Java实战项目之校园跑腿管理系统的实现

    Java实战项目之校园跑腿管理系统的实现

    只有理论是不够的,只有在实战中才能获得能力的提升,本篇文章手把手带你用java+Springboot+vue+maven+elementui+mysql实现一个校园跑腿管理系统,大家可以在过程中查缺补漏,提升水平
    2022-01-01
  • Java中URL传中文时乱码的解决方法

    Java中URL传中文时乱码的解决方法

    为什么说乱码是中国程序员无法避免的话题呢?这个主要是编码机制上的原因,大家都知道中文和英文的编码格式不一样,解码自然也不一样!这篇文章就给大家分享了Java中URL传中文时乱码的解决方法,有需要的朋友们可以参考借鉴。
    2016-10-10
  • Java中Hutool克隆功能的使用

    Java中Hutool克隆功能的使用

    本文主要介绍了Java中Hutool克隆功能的使用,cn.hutool.core.clone.Cloneable 是Hutool中提供的一个接口,用于支持对象的深度克隆操作,下面就一起来介绍一下
    2024-04-04
  • 最好的8个Java RESTful框架

    最好的8个Java RESTful框架

    最好的8个Java RESTful框架,需要的朋友可以参考下
    2016-05-05

最新评论