Skip to content

Commit ce7f0f7

Browse files
committed
Merge branch 'issues/add-log-when-springdoc-enabled' of github.com:zakaria-shahen/springdoc-openapi into zakaria-shahen-issues/add-log-when-springdoc-enabled
2 parents f01af05 + 7be8cfe commit ce7f0f7

File tree

3 files changed

+35
-0
lines changed

3 files changed

+35
-0
lines changed

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocConfiguration.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@
4444
import io.swagger.v3.oas.models.OpenAPI;
4545
import io.swagger.v3.oas.models.media.ObjectSchema;
4646
import io.swagger.v3.oas.models.media.Schema;
47+
import org.slf4j.Logger;
48+
import org.slf4j.LoggerFactory;
4749
import org.springdoc.api.ErrorMessage;
4850
import org.springdoc.api.OpenApiResourceNotFoundException;
4951
import org.springdoc.core.conditions.CacheOrGroupedOpenApiCondition;
@@ -101,6 +103,8 @@
101103
import org.springdoc.core.utils.PropertyResolverUtils;
102104
import org.springdoc.core.utils.SchemaUtils;
103105
import org.springdoc.core.utils.SpringDocKotlinUtils;
106+
import org.springframework.boot.context.event.ApplicationReadyEvent;
107+
import org.springframework.context.event.EventListener;
104108
import reactor.core.publisher.Flux;
105109

106110
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
@@ -152,6 +156,13 @@
152156
@ConditionalOnWebApplication
153157
public class SpringDocConfiguration {
154158

159+
protected static final Logger LOGGER = LoggerFactory.getLogger(SpringDocConfiguration.class);
160+
161+
@EventListener(ApplicationReadyEvent.class)
162+
public void init() {
163+
LOGGER.warn("SpringDoc /api-docs endpoint is enabled by default. To disable it in production, set the property '{}=false' in your production profile configuration.", SPRINGDOC_ENABLED);
164+
}
165+
155166
/**
156167
* The constant BINDRESULT_CLASS.
157168
*/

springdoc-openapi-starter-webflux-scalar/src/main/java/org/springdoc/webflux/scalar/ScalarConfiguration.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
package org.springdoc.webflux.scalar;
2828

2929
import com.scalar.maven.webjar.ScalarProperties;
30+
import org.slf4j.Logger;
31+
import org.slf4j.LoggerFactory;
3032
import org.springdoc.core.configuration.SpringDocConfiguration;
3133
import org.springdoc.core.properties.SpringDocConfigProperties;
3234

@@ -40,10 +42,12 @@
4042
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
4143
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
4244
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
45+
import org.springframework.boot.context.event.ApplicationReadyEvent;
4346
import org.springframework.boot.context.properties.EnableConfigurationProperties;
4447
import org.springframework.context.annotation.Bean;
4548
import org.springframework.context.annotation.Configuration;
4649
import org.springframework.context.annotation.Lazy;
50+
import org.springframework.context.event.EventListener;
4751
import org.springframework.web.server.adapter.ForwardedHeaderTransformer;
4852

4953
import static org.springdoc.core.utils.Constants.SPRINGDOC_SWAGGER_UI_ENABLED;
@@ -63,6 +67,14 @@
6367
@ConditionalOnProperty(prefix = "scalar", name = "enabled", havingValue = "true", matchIfMissing = true)
6468
public class ScalarConfiguration {
6569

70+
protected static final Logger LOGGER = LoggerFactory.getLogger(ScalarConfiguration.class);
71+
72+
@EventListener(ApplicationReadyEvent.class)
73+
public void init() {
74+
LOGGER.warn("SpringDoc Scalar is enabled by default. To disable it in production, set the property 'scalar.enabled=false' in your production profile configuration.");
75+
}
76+
77+
6678
/**
6779
* Scalar web mvc controller scalar web mvc controller.
6880
*

springdoc-openapi-starter-webmvc-scalar/src/main/java/org/springdoc/webmvc/scalar/ScalarConfiguration.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727
package org.springdoc.webmvc.scalar;
2828

2929
import com.scalar.maven.webjar.ScalarProperties;
30+
import org.slf4j.Logger;
31+
import org.slf4j.LoggerFactory;
3032
import org.springdoc.core.configuration.SpringDocConfiguration;
3133
import org.springdoc.core.properties.SpringDocConfigProperties;
3234

@@ -40,11 +42,13 @@
4042
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
4143
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
4244
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
45+
import org.springframework.boot.context.event.ApplicationReadyEvent;
4346
import org.springframework.boot.context.properties.EnableConfigurationProperties;
4447
import org.springframework.boot.web.servlet.FilterRegistrationBean;
4548
import org.springframework.context.annotation.Bean;
4649
import org.springframework.context.annotation.Configuration;
4750
import org.springframework.context.annotation.Lazy;
51+
import org.springframework.context.event.EventListener;
4852
import org.springframework.web.filter.ForwardedHeaderFilter;
4953

5054
import static org.springdoc.core.utils.Constants.SPRINGDOC_SWAGGER_UI_ENABLED;
@@ -64,6 +68,14 @@
6468
@ConditionalOnProperty(prefix = "scalar", name = "enabled", havingValue = "true", matchIfMissing = true)
6569
public class ScalarConfiguration {
6670

71+
72+
protected static final Logger LOGGER = LoggerFactory.getLogger(ScalarConfiguration.class);
73+
74+
@EventListener(ApplicationReadyEvent.class)
75+
public void init() {
76+
LOGGER.warn("SpringDoc Scalar is enabled by default. To disable it in production, set the property 'scalar.enabled=false' in your production profile configuration.");
77+
}
78+
6779
/**
6880
* Scalar web mvc controller scalar web mvc controller.
6981
*

0 commit comments

Comments
 (0)