Warning messages when docs are explicitly enabled. Fixes #3131

bnasslahsen · bnasslahsen · commit 98f19730df4f · 2025-11-11T14:41:23.000+01:00
diff --git a/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocConfiguration.java b/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocConfiguration.java
@@ -729,6 +729,6 @@ MethodParameterPojoExtractor methodParameterPojoExtractor(SchemaUtils schemaUtil
 	@ConditionalOnMissingBean(name = "springDocAppInitializer")
 	@Lazy(false)
 	SpringDocAppInitializer springDocAppInitializer(SpringDocConfigProperties springDocConfigProperties){
-		return new SpringDocAppInitializer(springDocConfigProperties.getApiDocs().getPath(), SPRINGDOC_ENABLED);
+		return new SpringDocAppInitializer(springDocConfigProperties.getApiDocs().getPath(), SPRINGDOC_ENABLED, springDocConfigProperties.getApiDocs().isEnabled());
 	}
 }
diff --git a/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/events/SpringDocAppInitializer.java b/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/events/SpringDocAppInitializer.java
@@ -54,22 +54,30 @@ public class SpringDocAppInitializer {
 	 */
 	private static final Logger LOGGER = LoggerFactory.getLogger(SpringDocAppInitializer.class);
 
+	/**
+	 * The Springdoc enabled.
+	 */
+	private final boolean springdocEnabled;
+
 	/**
 	 * Instantiates a new Spring doc app initializer.
 	 *
-	 * @param endpoint the endpoint
-	 * @param property the property
+	 * @param endpoint         the endpoint
+	 * @param property         the property
+	 * @param springdocEnabled the springdoc enabled
 	 */
-	public SpringDocAppInitializer(String endpoint, String property) {
+	public SpringDocAppInitializer(String endpoint, String property, boolean springdocEnabled) {
 		this.endpoint = endpoint;
 		this.property = property;
+		this.springdocEnabled = springdocEnabled;
 	}
 
 	/**
 	 * Init.
 	 */
 	@EventListener(ApplicationReadyEvent.class)
 	public void init() {
-		LOGGER.warn("SpringDoc {} endpoint is enabled by default. To disable it in production, set the property '{}=false'", endpoint, property);
+		if(!this.springdocEnabled)
+			LOGGER.warn("SpringDoc {} endpoint is enabled by default. To disable it in production, set the property '{}=false'", endpoint, property);
 	}
 }
diff --git a/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SpringDocConfigProperties.java b/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SpringDocConfigProperties.java
@@ -1434,7 +1434,7 @@ public static class ApiDocs {
 		/**
 		 * Whether to generate and serve an OpenAPI document.
 		 */
-		private boolean enabled = true;
+		private boolean enabled;
 
 		/**
 		 * The Resolve schema properties.
diff --git a/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SwaggerUiConfigProperties.java b/springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SwaggerUiConfigProperties.java
@@ -96,7 +96,7 @@ public class SwaggerUiConfigProperties extends AbstractSwaggerUiConfigProperties
 	/**
 	 * Whether to generate and serve an OpenAPI document.
 	 */
-	private boolean enabled = true;
+	private boolean enabled;
 
 	/**
 	 * The Use root path.
diff --git a/springdoc-openapi-starter-webflux-scalar/src/main/java/org/springdoc/webflux/scalar/ScalarConfiguration.java b/springdoc-openapi-starter-webflux-scalar/src/main/java/org/springdoc/webflux/scalar/ScalarConfiguration.java
@@ -102,7 +102,7 @@ ForwardedHeaderTransformer forwardedHeaderTransformer() {
 	@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)
 	@Lazy(false)
 	SpringDocAppInitializer springDocScalarInitializer(ScalarProperties scalarProperties) {
-		return new SpringDocAppInitializer(scalarProperties.getPath(), SCALAR_ENABLED);
+		return new SpringDocAppInitializer(scalarProperties.getPath(), SCALAR_ENABLED, scalarProperties.isEnabled());
 	}
 
 	/**
@@ -135,8 +135,8 @@ ScalarActuatorController scalarActuatorController(ScalarProperties properties, W
 		@Bean
 		@ConditionalOnMissingBean(name = "springDocScalarInitializer")
 		@Lazy(false)
-		SpringDocAppInitializer springDocScalarInitializer() {
-			return new SpringDocAppInitializer(DEFAULT_SCALAR_ACTUATOR_PATH, SCALAR_ENABLED);
+		SpringDocAppInitializer springDocScalarInitializer(ScalarProperties scalarProperties) {
+			return new SpringDocAppInitializer(DEFAULT_SCALAR_ACTUATOR_PATH, SCALAR_ENABLED, scalarProperties.isEnabled());
 		}
 	}
 
diff --git a/springdoc-openapi-starter-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerConfig.java b/springdoc-openapi-starter-webflux-ui/src/main/java/org/springdoc/webflux/ui/SwaggerConfig.java
@@ -195,7 +195,7 @@ SwaggerResourceResolver swaggerResourceResolver(SwaggerUiConfigProperties swagge
 	@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)
 	@Lazy(false)
 	SpringDocAppInitializer springDocSwaggerInitializer(SwaggerUiConfigProperties swaggerUiConfigProperties) {
-		return new SpringDocAppInitializer(swaggerUiConfigProperties.getPath(), SPRINGDOC_SWAGGER_UI_ENABLED);
+		return new SpringDocAppInitializer(swaggerUiConfigProperties.getPath(), SPRINGDOC_SWAGGER_UI_ENABLED, swaggerUiConfigProperties.isEnabled());
 	}
 	
 	/**
@@ -232,8 +232,8 @@ SwaggerWelcomeActuator swaggerActuatorWelcome(SwaggerUiConfigProperties swaggerU
 		@Bean
 		@ConditionalOnMissingBean(name = "springDocSwaggerInitializer")
 		@Lazy(false)
-		SpringDocAppInitializer springDocSwaggerInitializer() {
-			return new SpringDocAppInitializer(DEFAULT_SWAGGER_UI_ACTUATOR_PATH, SPRINGDOC_SWAGGER_UI_ENABLED);
+		SpringDocAppInitializer springDocSwaggerInitializer(SwaggerUiConfigProperties swaggerUiConfigProperties) {
+			return new SpringDocAppInitializer(DEFAULT_SWAGGER_UI_ACTUATOR_PATH, SPRINGDOC_SWAGGER_UI_ENABLED, swaggerUiConfigProperties.isEnabled());
 		}
 	}
 }
diff --git a/springdoc-openapi-starter-webmvc-scalar/src/main/java/org/springdoc/webmvc/scalar/ScalarConfiguration.java b/springdoc-openapi-starter-webmvc-scalar/src/main/java/org/springdoc/webmvc/scalar/ScalarConfiguration.java
@@ -103,7 +103,7 @@ public FilterRegistrationBean<ForwardedHeaderFilter> forwardedHeaderFilter() {
 	@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)
 	@Lazy(false)
 	SpringDocAppInitializer springDocScalarInitializer(ScalarProperties scalarProperties){
-		return new SpringDocAppInitializer(scalarProperties.getPath(), SCALAR_ENABLED);
+		return new SpringDocAppInitializer(scalarProperties.getPath(), SCALAR_ENABLED, scalarProperties.isEnabled());
 	}
 
 	/**
@@ -136,8 +136,8 @@ ScalarActuatorController scalarActuatorController(ScalarProperties properties,
 		@Bean
 		@ConditionalOnMissingBean(name = "springDocScalarInitializer")
 		@Lazy(false)
-		SpringDocAppInitializer springDocScalarInitializer(){
-			return new SpringDocAppInitializer(DEFAULT_SCALAR_ACTUATOR_PATH, SCALAR_ENABLED);
+		SpringDocAppInitializer springDocScalarInitializer(ScalarProperties scalarProperties){
+			return new SpringDocAppInitializer(DEFAULT_SCALAR_ACTUATOR_PATH, SCALAR_ENABLED, scalarProperties.isEnabled());
 		}
 	}
 
diff --git a/springdoc-openapi-starter-webmvc-ui/src/main/java/org/springdoc/webmvc/ui/SwaggerConfig.java b/springdoc-openapi-starter-webmvc-ui/src/main/java/org/springdoc/webmvc/ui/SwaggerConfig.java
@@ -183,7 +183,7 @@ SwaggerResourceResolver swaggerResourceResolver(SwaggerUiConfigProperties swagge
 	@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)
 	@Lazy(false)
 	SpringDocAppInitializer springDocSwaggerInitializer(SwaggerUiConfigProperties swaggerUiConfigProperties) {
-		return new SpringDocAppInitializer(swaggerUiConfigProperties.getPath(), SPRINGDOC_SWAGGER_UI_ENABLED);
+		return new SpringDocAppInitializer(swaggerUiConfigProperties.getPath(), SPRINGDOC_SWAGGER_UI_ENABLED, swaggerUiConfigProperties.isEnabled());
 	}
 
 	/**
@@ -217,8 +217,8 @@ SwaggerWelcomeActuator swaggerActuatorWelcome(SwaggerUiConfigProperties swaggerU
 		@Bean
 		@ConditionalOnMissingBean(name = "springDocSwaggerInitializer")
 		@Lazy(false)
-		SpringDocAppInitializer springDocSwaggerInitializer() {
-			return new SpringDocAppInitializer(DEFAULT_SWAGGER_UI_ACTUATOR_PATH, SPRINGDOC_SWAGGER_UI_ENABLED);
+		SpringDocAppInitializer springDocSwaggerInitializer(SwaggerUiConfigProperties swaggerUiConfigProperties) {
+			return new SpringDocAppInitializer(DEFAULT_SWAGGER_UI_ACTUATOR_PATH, SPRINGDOC_SWAGGER_UI_ENABLED, swaggerUiConfigProperties.isEnabled());
 		}
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -729,6 +729,6 @@ MethodParameterPojoExtractor methodParameterPojoExtractor(SchemaUtils schemaUtil`
`729`	`729`	`@ConditionalOnMissingBean(name = "springDocAppInitializer")`
`730`	`730`	`@Lazy(false)`
`731`	`731`	`SpringDocAppInitializer springDocAppInitializer(SpringDocConfigProperties springDocConfigProperties){`
`732`		`- return new SpringDocAppInitializer(springDocConfigProperties.getApiDocs().getPath(), SPRINGDOC_ENABLED);`
	`732`	`+ return new SpringDocAppInitializer(springDocConfigProperties.getApiDocs().getPath(), SPRINGDOC_ENABLED, springDocConfigProperties.getApiDocs().isEnabled());`
`733`	`733`	`}`
`734`	`734`	`}`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ ForwardedHeaderTransformer forwardedHeaderTransformer() {`
`102`	`102`	`@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)`
`103`	`103`	`@Lazy(false)`
`104`	`104`	`SpringDocAppInitializer springDocScalarInitializer(ScalarProperties scalarProperties) {`
`105`		`- return new SpringDocAppInitializer(scalarProperties.getPath(), SCALAR_ENABLED);`
	`105`	`+ return new SpringDocAppInitializer(scalarProperties.getPath(), SCALAR_ENABLED, scalarProperties.isEnabled());`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`/**`
`@@ -135,8 +135,8 @@ ScalarActuatorController scalarActuatorController(ScalarProperties properties, W`
`135`	`135`	`@Bean`
`136`	`136`	`@ConditionalOnMissingBean(name = "springDocScalarInitializer")`
`137`	`137`	`@Lazy(false)`
`138`		`- SpringDocAppInitializer springDocScalarInitializer() {`
`139`		`- return new SpringDocAppInitializer(DEFAULT_SCALAR_ACTUATOR_PATH, SCALAR_ENABLED);`
	`138`	`+ SpringDocAppInitializer springDocScalarInitializer(ScalarProperties scalarProperties) {`
	`139`	`+ return new SpringDocAppInitializer(DEFAULT_SCALAR_ACTUATOR_PATH, SCALAR_ENABLED, scalarProperties.isEnabled());`
`140`	`140`	`}`
`141`	`141`	`}`
`142`	`142`
Original file line number	Diff line number	Diff line change
`@@ -195,7 +195,7 @@ SwaggerResourceResolver swaggerResourceResolver(SwaggerUiConfigProperties swagge`
`195`	`195`	`@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)`
`196`	`196`	`@Lazy(false)`
`197`	`197`	`SpringDocAppInitializer springDocSwaggerInitializer(SwaggerUiConfigProperties swaggerUiConfigProperties) {`
`198`		`- return new SpringDocAppInitializer(swaggerUiConfigProperties.getPath(), SPRINGDOC_SWAGGER_UI_ENABLED);`
	`198`	`+ return new SpringDocAppInitializer(swaggerUiConfigProperties.getPath(), SPRINGDOC_SWAGGER_UI_ENABLED, swaggerUiConfigProperties.isEnabled());`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`/**`
`@@ -232,8 +232,8 @@ SwaggerWelcomeActuator swaggerActuatorWelcome(SwaggerUiConfigProperties swaggerU`
`232`	`232`	`@Bean`
`233`	`233`	`@ConditionalOnMissingBean(name = "springDocSwaggerInitializer")`
`234`	`234`	`@Lazy(false)`
`235`		`- SpringDocAppInitializer springDocSwaggerInitializer() {`
`236`		`- return new SpringDocAppInitializer(DEFAULT_SWAGGER_UI_ACTUATOR_PATH, SPRINGDOC_SWAGGER_UI_ENABLED);`
	`235`	`+ SpringDocAppInitializer springDocSwaggerInitializer(SwaggerUiConfigProperties swaggerUiConfigProperties) {`
	`236`	`+ return new SpringDocAppInitializer(DEFAULT_SWAGGER_UI_ACTUATOR_PATH, SPRINGDOC_SWAGGER_UI_ENABLED, swaggerUiConfigProperties.isEnabled());`
`237`	`237`	`}`
`238`	`238`	`}`
`239`	`239`	`}`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ public FilterRegistrationBean<ForwardedHeaderFilter> forwardedHeaderFilter() {`
`103`	`103`	`@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)`
`104`	`104`	`@Lazy(false)`
`105`	`105`	`SpringDocAppInitializer springDocScalarInitializer(ScalarProperties scalarProperties){`
`106`		`- return new SpringDocAppInitializer(scalarProperties.getPath(), SCALAR_ENABLED);`
	`106`	`+ return new SpringDocAppInitializer(scalarProperties.getPath(), SCALAR_ENABLED, scalarProperties.isEnabled());`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`/**`
`@@ -136,8 +136,8 @@ ScalarActuatorController scalarActuatorController(ScalarProperties properties,`
`136`	`136`	`@Bean`
`137`	`137`	`@ConditionalOnMissingBean(name = "springDocScalarInitializer")`
`138`	`138`	`@Lazy(false)`
`139`		`- SpringDocAppInitializer springDocScalarInitializer(){`
`140`		`- return new SpringDocAppInitializer(DEFAULT_SCALAR_ACTUATOR_PATH, SCALAR_ENABLED);`
	`139`	`+ SpringDocAppInitializer springDocScalarInitializer(ScalarProperties scalarProperties){`
	`140`	`+ return new SpringDocAppInitializer(DEFAULT_SCALAR_ACTUATOR_PATH, SCALAR_ENABLED, scalarProperties.isEnabled());`
`141`	`141`	`}`
`142`	`142`	`}`
`143`	`143`
Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ SwaggerResourceResolver swaggerResourceResolver(SwaggerUiConfigProperties swagge`
`183`	`183`	`@ConditionalOnProperty(name = SPRINGDOC_USE_MANAGEMENT_PORT, havingValue = "false", matchIfMissing = true)`
`184`	`184`	`@Lazy(false)`
`185`	`185`	`SpringDocAppInitializer springDocSwaggerInitializer(SwaggerUiConfigProperties swaggerUiConfigProperties) {`
`186`		`- return new SpringDocAppInitializer(swaggerUiConfigProperties.getPath(), SPRINGDOC_SWAGGER_UI_ENABLED);`
	`186`	`+ return new SpringDocAppInitializer(swaggerUiConfigProperties.getPath(), SPRINGDOC_SWAGGER_UI_ENABLED, swaggerUiConfigProperties.isEnabled());`
`187`	`187`	`}`
`188`	`188`
`189`	`189`	`/**`
`@@ -217,8 +217,8 @@ SwaggerWelcomeActuator swaggerActuatorWelcome(SwaggerUiConfigProperties swaggerU`
`217`	`217`	`@Bean`
`218`	`218`	`@ConditionalOnMissingBean(name = "springDocSwaggerInitializer")`
`219`	`219`	`@Lazy(false)`
`220`		`- SpringDocAppInitializer springDocSwaggerInitializer() {`
`221`		`- return new SpringDocAppInitializer(DEFAULT_SWAGGER_UI_ACTUATOR_PATH, SPRINGDOC_SWAGGER_UI_ENABLED);`
	`220`	`+ SpringDocAppInitializer springDocSwaggerInitializer(SwaggerUiConfigProperties swaggerUiConfigProperties) {`
	`221`	`+ return new SpringDocAppInitializer(DEFAULT_SWAGGER_UI_ACTUATOR_PATH, SPRINGDOC_SWAGGER_UI_ENABLED, swaggerUiConfigProperties.isEnabled());`
`222`	`222`	`}`
`223`	`223`	`}`
`224`	`224`	`}`