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 资源的自动配置和展示。

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

总结

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

相关文章

  • Jenkins+Git+Maven自动化部署配置详解

    Jenkins+Git+Maven自动化部署配置详解

    本文主要介绍了Jenkins+Git+Maven自动化部署配置详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-01-01
  • java http连接池的实现方式(带有失败重试等高级功能)

    java http连接池的实现方式(带有失败重试等高级功能)

    这篇文章主要介绍了java http连接池的实现方式(带有失败重试等高级功能),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • springboot CompletableFuture并行计算及使用方法

    springboot CompletableFuture并行计算及使用方法

    CompletableFuture基于 Future 和 CompletionStage 接口,利用线程池、回调函数、异常处理、组合操作等机制,提供了强大而灵活的异步编程功能,这篇文章主要介绍了springboot CompletableFuture并行计算及使用方法,需要的朋友可以参考下
    2024-05-05
  • Spring Boot中MongoTemplate从入门到实战深度解析

    Spring Boot中MongoTemplate从入门到实战深度解析

    本文介绍了Spring Data MongoDB中的MongoTemplate,包括主要特性、核心配置、基础CRUD、高级查询与聚合操作、GridFS操作、性能优化与监控以及最佳实践,通过全面的示例项目,展示了如何在Spring Boot应用中使用MongoTemplate进行数据库操作,感兴趣的朋友跟随小编一起看看吧
    2026-01-01
  • spring boot下mybatis配置双数据源的实例

    spring boot下mybatis配置双数据源的实例

    这篇文章主要介绍了spring boot下mybatis配置双数据源的实例,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • java8 stream 如何打印数据元素

    java8 stream 如何打印数据元素

    这篇文章主要介绍了java8 stream 如何打印数据元素,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-11-11
  • Spring Boot 2结合Spring security + JWT实现微信小程序登录

    Spring Boot 2结合Spring security + JWT实现微信小程序登录

    这篇文章主要介绍了Spring Boot 2结合Spring security + JWT实现微信小程序登录,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-01-01
  • Java SpringBoot在RequestBody中高效的使用枚举参数原理案例详解

    Java SpringBoot在RequestBody中高效的使用枚举参数原理案例详解

    这篇文章主要介绍了Java SpringBoot在RequestBody中高效的使用枚举参数原理案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-09-09
  • Springboot整合RabbitMQ消息中间件的使用

    Springboot整合RabbitMQ消息中间件的使用

    在没有特别要求的情况下,通常会选择RabbitMQ作为消息中间件,本文主要介绍了Springboot整合RabbitMQ消息中间件的使用,具有一定的参考价值,感兴趣的可以了解一下
    2023-11-11
  • SpringBoot事务失效的七种场景分析及解决方案

    SpringBoot事务失效的七种场景分析及解决方案

    Spring Boot 中的事务失效通常是由于代理机制、异常处理、传播行为配置不当等原因引起的,通过合理配置和排查,可以有效避免事务失效问题,所以本文给大家总结了SpringBoot事务失效的七种场景分析及解决方案,需要的朋友可以参考下
    2025-05-05

最新评论