实现Swagger只在开发环境与测试环境启用,生产环境不启用

本文作者:suxingrui
本文链接:https://blog.csdn.net/suxingrui/article/details/103788314
版权声明:本文为原创文章,转载请注明出处。

回顾2019年碰到的问题及解决方式
问题:实现Swagger只在开发环境与测试环境启用,生产环境不启用

问题发现:
配置Swagger,如果不做任何处理的话,在生产环境也会启用,就会存在一定的安全风险。
所以,引申出如题所述的实现目标。

调查分析:
然后,需要考虑的就是,不能每次编译打包都要修改配置或者代码来达到目标。
所以,可以使用@Conditional来实现。
如下所示,一个简单的实现方式:

解决方法:
1、先实现一个条件:SwaggerEnableCondition

public class SwaggerEnableCondition implements Condition {

	@Override
	public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
		String active = context.getEnvironment().getProperty("spring.profiles.active");
		return "dev".equals(active) || "test".equals(active);
	}

}

2、使用

@Conditional(SwaggerEnableCondition.class)
@EnableSwagger2
@Configuration
public class Swagger2 {

	@Value("${swagger.apis:}")
	private String apis;

	@Conditional(SwaggerEnableCondition.class)
	@Bean
	public Docket createDocket() {
		...
	}

}
  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
关闭Knife4j可以通过以下步骤: 1. 在pom.xml文件中移除knife4j依赖。如果使用的是Spring Boot,可以在pom.xml文件中找到相关的依赖并将其注释或删除。 2. 在Swagger配置类中禁用Knife4j。可以通过在Swagger配置类中添加以下代码来禁用Knife4j: ``` @Configuration @EnableSwagger2 public class SwaggerConfig { @Autowired private Environment env; @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("your.base.package")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()) .enable("dev".equals(env.getActiveProfiles()[0])); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Your API title") .description("Your API description") .version("1.0.0") .build(); } } ``` 在上面的代码中,我们通过在Docket bean中调用enable()方法来禁用Knife4j。在这个例子中,我们只在开发环境启用Swagger,而在其他环境中禁用它。 3. 在Web配置类中禁用Knife4j。如果使用的是Spring MVC,可以通过在Web配置类中添加以下代码来禁用Knife4j: ``` @Configuration public class WebMvcConfig implements WebMvcConfigurer { @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/"); } @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addRedirectViewController("/", "/swagger-ui.html"); } } ``` 在上面的代码中,我们通过重定向/请求到/swagger-ui.html来禁用Knife4j。这样,当我们访问应用程序的根路径时,将直接跳转到Swagger UI页面,而不是Knife4j页面。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值