接口文档神器---Swagger多环境控制

阳光下的米雪

于 2021-12-06 10:08:17 发布

阅读量519

点赞数

CC 4.0 BY-SA版权

分类专栏： Swagger 文章标签： java SpringBoot 多环境

本文链接：https://blog.csdn.net/qq_38530648/article/details/121740744

Swagger 专栏收录该内容

7 篇文章

订阅专栏

本文探讨如何通过@Profile注解和application.properties文件实现Swagger在不同环境（如dev、test、prod）下的控制，包括禁用线上Swagger的安全策略。遇到的报错及解决方案将帮助开发者理解并实践多环境部署的最佳实践。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger多环境控制

代码部署环境区分开发测试线上
基于安全考量线上禁用Swagger
通过多种配置方式支持多环境配置

多环境控制方式

首先，需要设置启动参数，本例设置启动参数是prod：
在这里插入图片描述

基于@Profile注解

@Configuration
@EnableSwagger2
//@EnableSwaggerBootstrapUI
@Profile({"dev", "test", "pre", "prod"})
public class Swagger2UiConfiguration extends WebMvcConfigurerAdapter  {
}

报错截图如下：
在这里插入图片描述

基于enable方法的控制方式

在application.properties中设置swagger2.enable=true

 @Value("${swagger2.enable}")
    private boolean swagger2Enable;

	@Bean
	public Docket api() {
		return new Docket(DocumentationType.SWAGGER_2)
                .enable(swagger2Enable)