Spring Boot(九)如何在生产环境禁用swagger

上篇主要是介绍了再SpringBoot框架下swagger的应用,感觉其中最大的一个障碍则是版本之间的冲突问题,希望使用的小伙伴们可以注意。本篇则主要是针对生产环境如何禁用swagger进行一下总结,来保证生产环境的安全。

方法一:Spring Profiles功能

Spring Profiles提供了一种隔离应用程序配置部分并使其仅在特定环境中可用的方法。任何@Component或@Configuration 可以标记@Profile以限制何时加载。当然您可以使用spring.profiles.active Environment属性指定哪些配置文件处于活动状态。直接在application.properties配置即可。
swagger注解

@Profile("swagger")
@Configuration
@EnableSwagger2
public class SwaggerConfig {

application.properties测试环境:

spring.profiles.active=dev,swagger

application.properties生产环境:

spring.profiles.active=prod

利用profiles是最合理的一种方式,因为application.properties是专门为spring服务的,当然在application.properties中可以添加我们任意的路径,那么则可以采用下面一种方式。

方法二:ConditionalOnProperty注解

应用ConditionalOnProperty注解也是需要依赖application.properties配置文件的,如下;
swagger注解

@Configuration
@ConditionalOnProperty(prefix = "swagger",value = {"enable"},havingValue = "true")
@EnableSwagger2
public class SwaggerConfig {

application.properties测试环境:

swagger.enable=true

application.properties生产环境:

swagger.enable=false

这里的属性key是 swagger.enable ,havingValue 是期望值,只有在值等于期望值的时候,才会生效。也就是说,swagger.enable只能为true的时候才会生效,其他值或不设值,都不会生效的。

三、笨方法逻辑判断

以上两种通过注解的方式实现其效果,是最方便快捷的,当然若不嫌麻烦,也可以通过在逻辑中判定的方式来做处理,这里则不变多说。

下篇则介绍在spring中如何集成swagger.

  • 2
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
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、付费专栏及课程。

余额充值