Review PR: Add pre-loading setting to load OpenAPI early. Fixes #854.

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -40,6 +40,8 @@
 import java.util.concurrent.Executors;
 import java.util.stream.Collectors;
 
+import javax.annotation.PostConstruct;
+
 import com.fasterxml.jackson.annotation.JsonView;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
@@ -201,10 +203,8 @@ protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIBuilder
 			operationCustomizers.get().removeIf(Objects::isNull);
 		this.operationCustomizers = operationCustomizers;
 		this.actuatorProvider = actuatorProvider;
-		if (springDocConfigProperties.isPreLoadingEnabled()) {
-			Executors.newSingleThreadExecutor()
-					.execute(this::getOpenApi);
-		}
+		if (springDocConfigProperties.isPreLoadingEnabled())
+			Executors.newSingleThreadExecutor().execute(this::getOpenApi);
 	}
 
 	/**
@@ -231,13 +231,13 @@ public static void addHiddenRestControllers(Class<?>... classes) {
 	 * @param classes the classes
 	 */
 	public static void addHiddenRestControllers(String... classes) {
-		Set<Class<?>> hiddenClasses =new HashSet<>();
+		Set<Class<?>> hiddenClasses = new HashSet<>();
 		for (String aClass : classes) {
 			try {
 				hiddenClasses.add(Class.forName(aClass));
 			}
 			catch (ClassNotFoundException e) {
-				LOGGER.warn("The following class doesn't exist and cannot be hidden: {}",  aClass);
+				LOGGER.warn("The following class doesn't exist and cannot be hidden: {}", aClass);
 			}
 		}
 		HIDDEN_REST_CONTROLLERS.addAll(hiddenClasses);
@@ -262,8 +262,8 @@ protected synchronized OpenAPI getOpenApi() {
 			Map<String, Object> findControllerAdvice = openAPIBuilder.getControllerAdviceMap();
 			// calculate generic responses
 			openApi = openAPIBuilder.getCalculatedOpenAPI();
-			if (springDocConfigProperties.isOverrideWithGenericResponse() && !CollectionUtils.isEmpty(findControllerAdvice)){
-				if(!CollectionUtils.isEmpty(mappingsMap))
+			if (springDocConfigProperties.isOverrideWithGenericResponse() && !CollectionUtils.isEmpty(findControllerAdvice)) {
+				if (!CollectionUtils.isEmpty(mappingsMap))
 					findControllerAdvice.putAll(mappingsMap);
 				responseBuilder.buildGenericResponse(openApi.getComponents(), findControllerAdvice);
 			}
@@ -969,7 +969,7 @@ protected void initOpenAPIBuilder() {
 	 * @return the yaml mapper
 	 */
 	protected ObjectMapper getYamlMapper() {
-		ObjectMapper objectMapper  =  Yaml.mapper();
+		ObjectMapper objectMapper = Yaml.mapper();
 		YAMLFactory factory = (YAMLFactory) objectMapper.getFactory();
 		factory.configure(Feature.USE_NATIVE_TYPE_ID, false);
 		return objectMapper;

springdoc-openapi-common/src/main/java/org/springdoc/core/OpenAPIBuilder.java

@@ -225,7 +225,7 @@ else if (calculatedOpenAPI.getInfo() == null) {
 	 * @return the open api
 	 */
 	public OpenAPI updateServers(OpenAPI openAPI) {
-		if (!isServersPresent)        // default server value
+		if (!isServersPresent && serverBaseUrl!=null)        // default server value
 		{
 			Server server = new Server().url(serverBaseUrl).description(DEFAULT_SERVER_DESCRIPTION);
 			List<Server> servers = new ArrayList<>();

springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java

@@ -133,7 +133,7 @@ public class SpringDocConfigProperties {
 	/**
 	 * Allow for pre-loading OpenAPI
 	 */
-	private boolean preLoadingEnabled = false;
+	private boolean preLoadingEnabled;
 
 	/**
 	 * Is use fqn boolean.
@@ -477,10 +477,20 @@ public void setWriterWithDefaultPrettyPrinter(boolean writerWithDefaultPrettyPri
 		this.writerWithDefaultPrettyPrinter = writerWithDefaultPrettyPrinter;
 	}
 
+	/**
+	 * Sets pre loading enabled.
+	 *
+	 * @param preLoadingEnabled the pre loading enabled
+	 */
 	public void setPreLoadingEnabled(boolean preLoadingEnabled) {
 		this.preLoadingEnabled = preLoadingEnabled;
 	}
 
+	/**
+	 * Is pre loading enabled boolean.
+	 *
+	 * @return the boolean
+	 */
 	public boolean isPreLoadingEnabled() {
 		return preLoadingEnabled;
 	}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app18/SpringDocApp18Test.java

@@ -21,7 +21,9 @@
 import test.org.springdoc.api.AbstractSpringDocTest;
 
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
 
+@TestPropertySource(properties = "springdoc.pre-loading-enabled=true")
 public class SpringDocApp18Test extends AbstractSpringDocTest {
 
 	@SpringBootApplication