Spring Boot 禁用 Swagger 的三种方式

最新推荐文章于 2024-05-18 14:25:02 发布
最新推荐文章于 2024-05-18 14:25:02 发布
阅读量4k 收藏 6
点赞数 6
分类专栏： 为霞而作 文章标签： Boot禁用Swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Mrs_chens/article/details/104961194
版权

📖摘要

今天分享下 —— Spring Boot 禁用 Swagger 的三种方式 的一些基本知识，欢迎关注！

在生产环境下，我们需要关闭swagger配置，避免暴露接口的这种危险行为。

🌂方法

🌂禁用方法1：

使用注解 @Value() 推荐使用

package com.dc.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author sunny chen
 * @version V1.0
 * @Package com.dc.config
 * @date 2018/1/16 17:33
 * @Description: 主要用途：开启在线接口文档和添加相关配置
 */
@Configuration
@EnableSwagger2
public class Swagger2Config extends WebMvcConfigurerAdapter {

    @Value("${swagger.enable}")
    private Boolean enable;
   
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .enable(enable)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dc.controller"))
                .paths(PathSelectors.any())
                //.paths(PathSelectors.none())
                .build();
    }

    private ApiInfo apiInfo()  {
        return new ApiInfoBuilder()
                .title("auth系统数据接口文档")
                .description("此系统为新架构Api说明文档")
                .termsOfServiceUrl("")
                .contact(new Contact("陈永佳 chen867647213@163.com", "", "https://blog.csdn.net/Mrs_chens"))
                .version("1.0")
                .build();
    }

    /**
     * swagger ui资源映射
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    /**
     * swagger-ui.html路径映射，浏览器中使用/api-docs访问
     * @param registry
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addRedirectViewController("/api-docs","/swagger-ui.html");
    }
}
🌂禁用方法2：

使用注解 @Profile({“dev”,“test”}) 表示在开发或测试环境开启，而在生产关闭。（推荐使用）

package com.dc.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author sunny chen
 * @version V1.0
 * @Package com.dc.config
 * @date 2018/1/16 17:33
 * @Description: 主要用途：开启在线接口文档和添加相关配置
 */
@Configuration
@EnableSwagger2
@Profile({“dev”,“test”})
public class Swagger2Config extends WebMvcConfigurerAdapter {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dc.controller"))
                .paths(PathSelectors.any())
                //.paths(PathSelectors.none())
                .build();
    }

    private ApiInfo apiInfo()  {
        return new ApiInfoBuilder()
                .title("auth系统数据接口文档")
                .description("此系统为新架构Api说明文档")
                .termsOfServiceUrl("")
                .contact(new Contact("陈永佳 chen867647213@163.com", "", "https://blog.csdn.net/Mrs_chens"))
                .version("1.0")
                .build();
    }

    /**
     * swagger ui资源映射
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    /**
     * swagger-ui.html路径映射，浏览器中使用/api-docs访问
     * @param registry
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addRedirectViewController("/api-docs","/swagger-ui.html");
    }
}
🌂禁用方法3：

使用注解 @ConditionalOnProperty(name = “swagger.enable”, havingValue = “true”) 然后在测试配置或者开发配置中 添加 swagger.enable = true 即可开启，生产环境不填则默认关闭 Swagger.

package com.dc.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author sunny chen
 * @version V1.0
 * @Package com.dc.config
 * @date 2018/1/16 17:33
 * @Description: 主要用途：开启在线接口文档和添加相关配置
 */
@Configuration
@EnableSwagger2
@ConditionalOnProperty(name ="enabled" ,prefix = "swagger",havingValue = "true",matchIfMissing = true)
public class Swagger2Config extends WebMvcConfigurerAdapter {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dc.controller"))
                .paths(PathSelectors.any())
                //.paths(PathSelectors.none())
                .build();
    }

    private ApiInfo apiInfo()  {
        return new ApiInfoBuilder()
                .title("auth系统数据接口文档")
                .description("此系统为新架构Api说明文档")
                .termsOfServiceUrl("")
                .contact(new Contact("陈永佳 chen867647213@163.com", "", "https://blog.csdn.net/Mrs_chens"))
                .version("1.0")
                .build();
    }

    /**
     * swagger ui资源映射
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    /**
     * swagger-ui.html路径映射，浏览器中使用/api-docs访问
     * @param registry
     */
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addRedirectViewController("/api-docs","/swagger-ui.html");
    }
}


#Swagger lock
swagger:
    enabled: true

🎉最后

  • 更多参考精彩博文请看这里：《陈永佳的博客》

  • 喜欢博主的小伙伴可以加个关注、点个赞哦，持续更新嘿嘿！

陈永佳
关注
  • 6
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
专栏目录
spring-boot 禁用swagger的方法
08-28
Spring Boot 禁用 Swagger 的方法 在 Spring Boot 项目中，Swagger 是一个非常有用的工具，可以生成 API 文档，并提供 UI 界面来查看 API 的路径、参数等信息。但是，在生产环境中，我们需要禁用 Swagger，以避免...
SpringBoot在生产快速禁用Swagger2的方法步骤
08-26
主要介绍了SpringBoot在生产快速禁用Swagger2的方法步骤，使用注解关闭Swagger2，避免接口重复暴露，非常具有实用价值，需要的朋友可以参考下
Spring Boot 禁用 Swagger 的三种方式(1)
2401_83816970的博客
04-18 1439
引领完成Docker的安装、部署、管理和扩展，让其经历从测试到生产的整个开发生命周期，深入了解Docker适用于什么场景。并且这本Docker的学习权威指南介绍了其组件的基础知识，然后用Docker构建容器和服务来完成各种任务：利用Docker为新项目建立测试环境，演示如何使用持续集成的工作流集成Docker，如何构建应用程序服务和平台，如何使用Docker的API，如何扩展Docker。
【问题篇】记录多种方式解决swagger2和swagger3的漏洞
最新发布
weixin_56995925的博客
05-18 1144
在工作中使用swagger时，一旦项目上线肯定是需要在生产环境关闭swagger的，本文针对swagger2和swagger3的各种情况进行记录。
Java SpringBoot关闭线上Swagger
weixin_44832006的博客
03-11 949
3.在需要部署正式版本时，把yml对应的版本环境切换至生产环境时，将无法打开swagger-ui.html 和doc.html。2.application.yml 在每个开发环境配置对应的swagger是否可以使用。1.swaggerConfig添加 ConditionalOnProperty注解。前言： 正常线上接口文档是不开启的，以防被人盗刷接口，影响正常人员的使用。
springboot项目关闭swagger防止漏洞扫描
cuper_的博客
04-12 2618
项目彻底关闭swagger以应对安全扫描
SpringBoot 通过配置禁用swagger
Lambda
05-29 1553
SpringBoot 通过配置禁用swagger 禁用方法1： 禁用方法2： 禁用方法3： 一、序言 在生产环境下，我们需要关闭swagger配置，避免暴露接口的这种危险行为。 二、方法： 禁用方法1： 使用注解 @Value() 推荐使用 package com.dc.config; import org.springframework.boot.autoconfigure...
SpringBoot中如何使用配置禁用swagger呢？
qq_25073223的博客
07-16 931
SpringBoot中使用配置禁用swagger的方法分享
Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题
09-07
在Spring Boot应用中，Swagger是一个强大的工具，它可以帮助开发者生成、描述、测试和展示RESTful API。Swagger UI是Swagger的一部分，提供了一个用户友好的界面，允许用户交互式地浏览和测试API。然而，在Spring ...
Java Spring Boot面试题
09-30
Spring Boot 可以与多种第三方项目集成，例如 Web Sockets、Spring Data、Spring Batch、FreeMarker 模板、Apache Kafka、Swagger 等。这些第三方项目可以帮助开发者快速构建应用程序。 其他 Spring Boot 项目可以...
Spring Boot面试题（最新版）-重点.pdf
10-05
整合第三方项目：Spring Boot可以方便地与各种第三方库集成，如WebSockets、Spring Data、Spring Batch、FreeMarker、ActiveMQ、Apache Kafka、Swagger等，通过添加对应的starter依赖即可快速集成。 其他问题如热...
生产环境下springboot中配置禁用swagger
老王的orange
08-27 6215
一、序言 在生产环境下，我们需要关闭swagger配置，避免暴露接口的这种危险行为。 二、方法： 禁用方法1：使用注解@Profile({"dev","test"}) 表示在开发或测试环境开启，而在生产关闭。（推荐使用） 禁用方法2：使用注解@ConditionalOnProperty(name = "swagger.enable", havingValue = "true") 然后在测试...
Swagger禁用的问题说明
maple田田的专栏
05-16 1292
3.集团提供了一个关闭Swagger的方法，在yml配置文件中加入：我们提供了一个swagger这块的开关，pfpj.springfox.enabled，配置为false的话，就不会加载swagger了。2.我们加载的包集团自己增加了一个Bean于是导致自己写的Config不生效，于是自己写的Config需要去掉或者注释掉。1.首先Application.java上的标签，需要去掉@EnableSwagger2的注解。踩了很多坑，三个都满足，才能完全禁用swagger！
Springboot线上环境彻底关闭Swagger-UI
l_mmf的博客
06-01 6535
2.创建一个控制类使用@Profile仅线上环境生效,使访问swagger-ui.html返回404。通过这种方式可以彻底关闭线上环境访问swagger-ui.html直接返回404。1.SwaggerConfig使用@Profile排除线上环境其他环境生效。Springboot线上环境彻底关闭Swagger-UI。
如何swagger关闭及给swagger加参数信息
weixin_43949154的博客
10-12 2176
项目的swagger方便研发人员调试，上线之后需要将swagger关闭这时候需要给原来的@Configuration注解换成@ConditionlOnProperty注解及可。首先是正常的swagger配置正常界面及调试方法界面。若swagger想加入额外参数类型，代码如下。
springfox接口文档如何关闭
TingSty小z的博客
02-20 4804
接口文档区分生产环境和开发环境，如何通过开关控制
Spring Boot 禁用 Swagger
06-01
在 Spring Boot 项目中，可以通过添加配置来禁用 Swagger。 1. 针对整个应用禁用 Swagger 可以在应用的 `application.properties` 文件中添加以下配置： ```properties springfox.documentation.enabled=false ``` 或者在应用的启动类上添加 `@EnableSwagger2` 注解，并重写 `addResourceHandlers` 方法，将 Swagger UI 的访问路径重定向到 `/error`： ```java import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration @EnableSwagger2 public class SwaggerConfig implements WebMvcConfigurer { @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/swagger-ui.html") .addResourceLocations("classpath:/META-INF/resources/") .setCachePeriod(0); registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/") .setCachePeriod(0); registry.addResourceHandler("/**") .addResourceLocations("classpath:/static/") .setCachePeriod(0); registry.addResourceHandler("/swagger-resources/**") .addResourceLocations("classpath:/META-INF/swagger-resources/") .setCachePeriod(0); } } ``` 2. 针对指定的 API 禁用 Swagger 可以在 API 的实现类上添加 `@ApiIgnore` 注解，例如： ```java @RestController @RequestMapping("/api") @ApiIgnore public class MyController { // ... } ``` 这样，Swagger 将不会显示该 API。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

陈永佳

你的鼓励将是我创作的最大动力！

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值