use ObjectFactory<OpenAPIBuilder> inside AbstractOpenApiResource

Author: bnasslahsen

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

@@ -74,6 +74,7 @@
 import org.springdoc.core.fn.RouterFunctionData;
 import org.springdoc.core.fn.RouterOperation;
 
+import org.springframework.beans.factory.ObjectFactory;
 import org.springframework.context.ApplicationContext;
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.core.annotation.AnnotationUtils;
@@ -110,7 +111,12 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	/**
 	 * The Open api builder.
 	 */
-	protected final OpenAPIBuilder openAPIBuilder;
+	protected OpenAPIBuilder openAPIBuilder;
+
+	/**
+	 * The open api builder object factory.
+	 */
+	private final ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory;
 
 	/**
 	 * The Spring doc config properties.
@@ -161,7 +167,7 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 * Instantiates a new Abstract open api resource.
 	 *
 	 * @param groupName the group name
-	 * @param openAPIBuilder the open api builder
+	 * @param openAPIBuilderObjectFactory the open api builder object factory
 	 * @param requestBuilder the request builder
 	 * @param responseBuilder the response builder
 	 * @param operationParser the operation parser
@@ -170,7 +176,7 @@ public abstract class AbstractOpenApiResource extends SpecFilter {
 	 * @param springDocConfigProperties the spring doc config properties
 	 * @param actuatorProvider the actuator provider
 	 */
-	protected AbstractOpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder,
+	protected AbstractOpenApiResource(String groupName, ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory,
 			AbstractRequestBuilder requestBuilder,
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			Optional<List<OperationCustomizer>> operationCustomizers,
@@ -179,7 +185,8 @@ protected AbstractOpenApiResource(String groupName, OpenAPIBuilder openAPIBuilde
 			Optional<ActuatorProvider> actuatorProvider) {
 		super();
 		this.groupName = Objects.requireNonNull(groupName, "groupName");
-		this.openAPIBuilder = openAPIBuilder;
+		this.openAPIBuilderObjectFactory = openAPIBuilderObjectFactory;
+		this.openAPIBuilder = openAPIBuilderObjectFactory.getObject();
 		this.requestBuilder = requestBuilder;
 		this.responseBuilder = responseBuilder;
 		this.operationParser = operationParser;
@@ -933,4 +940,9 @@ else if (existingOperation != null) {
 		return operation;
 	}
 
+	protected void initOpenAPIBuilder() {
+		if (openAPIBuilder.getCachedOpenAPI() != null && springDocConfigProperties.isCacheDisabled()) {
+			openAPIBuilder = openAPIBuilderObjectFactory.getObject();
+		}
+	}
 }

springdoc-openapi-hateoas/src/test/java/test/org/springdoc/api/app5/controller/CompanyController.java

@@ -7,7 +7,6 @@
 import lombok.RequiredArgsConstructor;
 import test.org.springdoc.api.app5.entities.CompanyDto;
 
-import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RestController;

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/MultipleOpenApiResource.java

@@ -140,7 +140,7 @@ public void afterPropertiesSet() throws Exception {
 							GroupConfig groupConfig = new GroupConfig(item.getGroup(), item.getPathsToMatch(), item.getPackagesToScan(), item.getPackagesToExclude(), item.getPathsToExclude());
 							springDocConfigProperties.addGroupConfig(groupConfig);
 							return new OpenApiResource(item.getGroup(),
-									defaultOpenAPIBuilder.getObject(),
+									defaultOpenAPIBuilder,
 									requestBuilder,
 									responseBuilder,
 									operationParser,

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/api/OpenApiResource.java

@@ -45,6 +45,7 @@
 import org.springdoc.webflux.core.visitor.RouterFunctionVisitor;
 import reactor.core.publisher.Mono;
 
+import org.springframework.beans.factory.ObjectFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.ApplicationContext;
@@ -82,7 +83,7 @@ public class OpenApiResource extends AbstractOpenApiResource {
 	 * Instantiates a new Open api resource.
 	 *
 	 * @param groupName the group name
-	 * @param openAPIBuilder the open api builder
+	 * @param openAPIBuilderObjectFactory the open api builder object factory
 	 * @param requestBuilder the request builder
 	 * @param responseBuilder the response builder
 	 * @param operationParser the operation parser
@@ -92,21 +93,21 @@ public class OpenApiResource extends AbstractOpenApiResource {
 	 * @param springDocConfigProperties the spring doc config properties
 	 * @param actuatorProvider the actuator provider
 	 */
-	public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+	public OpenApiResource(String groupName, ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory, AbstractRequestBuilder requestBuilder,
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
 			Optional<List<OperationCustomizer>> operationCustomizers,
 			Optional<List<OpenApiCustomiser>> openApiCustomisers,
 			SpringDocConfigProperties springDocConfigProperties,
 			Optional<ActuatorProvider> actuatorProvider) {
-		super(groupName, openAPIBuilder, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, springDocConfigProperties,actuatorProvider);
+		super(groupName, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, springDocConfigProperties, actuatorProvider);
 		this.requestMappingHandlerMapping = requestMappingHandlerMapping;
 	}
 
 	/**
 	 * Instantiates a new Open api resource.
 	 *
-	 * @param openAPIBuilder the open api builder
+	 * @param openAPIBuilderObjectFactory the open api builder object factory
 	 * @param requestBuilder the request builder
 	 * @param responseBuilder the response builder
 	 * @param operationParser the operation parser
@@ -117,14 +118,14 @@ public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, Abstract
 	 * @param actuatorProvider the actuator provider
 	 */
 	@Autowired
-	public OpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+	public OpenApiResource(ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory, AbstractRequestBuilder requestBuilder,
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
 			Optional<List<OperationCustomizer>> operationCustomizers,
 			Optional<List<OpenApiCustomiser>> openApiCustomisers,
 			SpringDocConfigProperties springDocConfigProperties,
 			Optional<ActuatorProvider> actuatorProvider) {
-		super(DEFAULT_GROUP_NAME, openAPIBuilder, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, springDocConfigProperties,actuatorProvider);
+		super(DEFAULT_GROUP_NAME, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, springDocConfigProperties, actuatorProvider);
 		this.requestMappingHandlerMapping = requestMappingHandlerMapping;
 	}
 
@@ -197,8 +198,8 @@ protected void calculatePath(Map<String, Object> restControllers, Map<RequestMap
 				Map<String, String> regexMap = new LinkedHashMap<>();
 				operationPath = PathUtils.parsePath(operationPath, regexMap);
 				if (operationPath.startsWith(DEFAULT_PATH_SEPARATOR)
-								&& (restControllers.containsKey(handlerMethod.getBean().toString()) || actuatorProvider.isPresent())
-								&& isPackageToScan(handlerMethod.getBeanType().getPackage()) && isPathToMatch(operationPath)) {
+						&& (restControllers.containsKey(handlerMethod.getBean().toString()) || actuatorProvider.isPresent())
+						&& isPackageToScan(handlerMethod.getBeanType().getPackage()) && isPathToMatch(operationPath)) {
 					Set<RequestMethod> requestMethods = requestMappingInfo.getMethodsCondition().getMethods();
 					// default allowed requestmethods
 					if (requestMethods.isEmpty())
@@ -230,6 +231,7 @@ protected void getWebFluxRouterFunctionPaths() {
 	 * @param apiDocsUrl the api docs url
 	 */
 	protected void calculateServerUrl(ServerHttpRequest serverHttpRequest, String apiDocsUrl) {
+		super.initOpenAPIBuilder();
 		String requestUrl = decode(serverHttpRequest.getURI().toString());
 		String serverBaseUrl = requestUrl.substring(0, requestUrl.length() - apiDocsUrl.length());
 		openAPIBuilder.setServerBaseUrl(serverBaseUrl);

springdoc-openapi-webflux-core/src/main/java/org/springdoc/webflux/core/SpringDocWebFluxConfiguration.java

@@ -40,6 +40,7 @@
 import org.springdoc.webflux.api.OpenApiResource;
 import org.springdoc.webflux.core.converters.WebFluxSupportConverter;
 
+import org.springframework.beans.factory.ObjectFactory;
 import org.springframework.boot.actuate.autoconfigure.web.server.ConditionalOnManagementPort;
 import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
 import org.springframework.boot.actuate.endpoint.web.reactive.WebFluxEndpointHandlerMapping;
@@ -68,7 +69,7 @@ public class SpringDocWebFluxConfiguration {
 	/**
 	 * Open api resource open api resource.
 	 *
-	 * @param openAPIBuilder the open api builder 
+	 * @param openAPIBuilderObjectFactory the open api builder object factory
 	 * @param requestBuilder the request builder 
 	 * @param responseBuilder the response builder 
 	 * @param operationParser the operation parser 
@@ -82,14 +83,14 @@ public class SpringDocWebFluxConfiguration {
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	OpenApiResource openApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+	OpenApiResource openApiResource(ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory, AbstractRequestBuilder requestBuilder,
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
 			Optional<List<OperationCustomizer>> operationCustomizers,
 			Optional<List<OpenApiCustomiser>> openApiCustomisers,
 			SpringDocConfigProperties springDocConfigProperties,
 			Optional<ActuatorProvider> actuatorProvider) {
-		return new OpenApiResource(openAPIBuilder, requestBuilder,
+		return new OpenApiResource(openAPIBuilderObjectFactory, requestBuilder,
 				responseBuilder, operationParser,
 				requestMappingHandlerMapping,operationCustomizers,
 				openApiCustomisers, springDocConfigProperties,actuatorProvider);

springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/MultipleOpenApiResource.java

@@ -165,7 +165,7 @@ public void afterPropertiesSet() throws Exception {
 							GroupConfig groupConfig = new GroupConfig(item.getGroup(), item.getPathsToMatch(), item.getPackagesToScan(), item.getPackagesToExclude(), item.getPathsToExclude());
 							springDocConfigProperties.addGroupConfig(groupConfig);
 							return new OpenApiResource(item.getGroup(),
-									defaultOpenAPIBuilder.getObject(),
+									defaultOpenAPIBuilder,
 									requestBuilder,
 									responseBuilder,
 									operationParser,

springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/api/OpenApiResource.java

@@ -48,6 +48,7 @@
 import org.springdoc.core.customizers.OperationCustomizer;
 import org.springdoc.core.fn.RouterOperation;
 
+import org.springframework.beans.factory.ObjectFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.core.annotation.AnnotationUtils;
@@ -99,7 +100,7 @@ public class OpenApiResource extends AbstractOpenApiResource {
 	 * Instantiates a new Open api resource.
 	 *
 	 * @param groupName the group name
-	 * @param openAPIBuilder the open api builder
+	 * @param openAPIBuilderObjectFactory the open api builder object factory
 	 * @param requestBuilder the request builder
 	 * @param responseBuilder the response builder
 	 * @param operationParser the operation parser
@@ -112,7 +113,7 @@ public class OpenApiResource extends AbstractOpenApiResource {
 	 * @param routerFunctionProvider the router function provider
 	 * @param repositoryRestResourceProvider the repository rest resource provider
 	 */
-	public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+	public OpenApiResource(String groupName, ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory, AbstractRequestBuilder requestBuilder,
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
 			Optional<ActuatorProvider> actuatorProvider,
@@ -122,7 +123,7 @@ public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, Abstract
 			Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,
 			Optional<RouterFunctionProvider> routerFunctionProvider,
 			Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider) {
-		super(groupName, openAPIBuilder, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, springDocConfigProperties,actuatorProvider);
+		super(groupName, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, springDocConfigProperties,actuatorProvider);
 		this.requestMappingHandlerMapping = requestMappingHandlerMapping;
 		this.springSecurityOAuth2Provider = springSecurityOAuth2Provider;
 		this.routerFunctionProvider = routerFunctionProvider;
@@ -132,7 +133,7 @@ public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, Abstract
 	/**
 	 * Instantiates a new Open api resource.
 	 *
-	 * @param openAPIBuilder the open api builder
+	 * @param openAPIBuilderObjectFactory the open api builder object factory
 	 * @param requestBuilder the request builder
 	 * @param responseBuilder the response builder
 	 * @param operationParser the operation parser
@@ -146,7 +147,7 @@ public OpenApiResource(String groupName, OpenAPIBuilder openAPIBuilder, Abstract
 	 * @param repositoryRestResourceProvider the repository rest resource provider
 	 */
 	@Autowired
-	public OpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+	public OpenApiResource(ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory, AbstractRequestBuilder requestBuilder,
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
 			Optional<ActuatorProvider> actuatorProvider,
@@ -156,7 +157,7 @@ public OpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder req
 			Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,
 			Optional<RouterFunctionProvider> routerFunctionProvider,
 			Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider) {
-		super(DEFAULT_GROUP_NAME, openAPIBuilder, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, springDocConfigProperties,actuatorProvider);
+		super(DEFAULT_GROUP_NAME, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, operationCustomizers, openApiCustomisers, springDocConfigProperties,actuatorProvider);
 		this.requestMappingHandlerMapping = requestMappingHandlerMapping;
 		this.springSecurityOAuth2Provider = springSecurityOAuth2Provider;
 		this.routerFunctionProvider = routerFunctionProvider;
@@ -288,8 +289,10 @@ protected boolean isRestController(Map<String, Object> restControllers, HandlerM
 	 * @param apiDocsUrl the api docs url
 	 */
 	protected void calculateServerUrl(HttpServletRequest request, String apiDocsUrl) {
+		super.initOpenAPIBuilder();
 		String requestUrl = decode(request.getRequestURL().toString());
 		String calculatedUrl = requestUrl.substring(0, requestUrl.length() - apiDocsUrl.length());
 		openAPIBuilder.setServerBaseUrl(calculatedUrl);
 	}
+
 }

springdoc-openapi-webmvc-core/src/main/java/org/springdoc/webmvc/core/SpringDocWebMvcConfiguration.java

@@ -43,6 +43,7 @@
 import org.springdoc.webmvc.api.RouterFunctionProvider;
 import org.springdoc.webmvc.api.WebMvcActuatorProvider;
 
+import org.springframework.beans.factory.ObjectFactory;
 import org.springframework.boot.actuate.autoconfigure.web.server.ConditionalOnManagementPort;
 import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
 import org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping;
@@ -73,7 +74,7 @@ public class SpringDocWebMvcConfiguration {
 	/**
 	 * Open api resource open api resource.
 	 *
-	 * @param openAPIBuilder the open api builder
+	 * @param openAPIBuilderObjectFactory the open api builder object factory
 	 * @param requestBuilder the request builder
 	 * @param responseBuilder the response builder
 	 * @param operationParser the operation parser
@@ -90,7 +91,7 @@ public class SpringDocWebMvcConfiguration {
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	OpenApiResource openApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
+	OpenApiResource openApiResource(ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory, AbstractRequestBuilder requestBuilder,
 			GenericResponseBuilder responseBuilder, OperationBuilder operationParser,
 			RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
 			Optional<ActuatorProvider> actuatorProvider,
@@ -100,7 +101,7 @@ OpenApiResource openApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBu
 			Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,
 			Optional<RouterFunctionProvider> routerFunctionProvider,
 			Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider) {
-		return new OpenApiResource(openAPIBuilder, requestBuilder,
+		return new OpenApiResource(openAPIBuilderObjectFactory, requestBuilder,
 				responseBuilder, operationParser,
 				requestMappingHandlerMapping, actuatorProvider, operationCustomizers,
 				openApiCustomisers, springDocConfigProperties, springSecurityOAuth2Provider,

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app94/SpringDocApp94Test.java

@@ -44,6 +44,7 @@
 import test.org.springdoc.api.app91.Greeting;
 
 import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.ObjectFactory;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.ApplicationContext;
@@ -92,13 +93,13 @@ public RequestMappingHandlerMapping defaultTestHandlerMapping(GreetingController
 		}
 
 		@Bean(name = "openApiResource")
-		public OpenApiResource openApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder, GenericResponseBuilder responseBuilder,
+		public OpenApiResource openApiResource(ObjectFactory<OpenAPIBuilder> openAPIBuilderObjectFactory, AbstractRequestBuilder requestBuilder, GenericResponseBuilder responseBuilder,
 				OperationBuilder operationParser,Optional<List<OperationCustomizer>> operationCustomizers,
 				@Qualifier("defaultTestHandlerMapping") RequestMappingHandlerMapping requestMappingHandlerMapping,
 				Optional<ActuatorProvider> actuatorProvider, SpringDocConfigProperties springDocConfigProperties,
 				Optional<List<OpenApiCustomiser>> openApiCustomisers, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,
 				Optional<RouterFunctionProvider> routerFunctionProvider, Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider) {
-			return new OpenApiResource(DEFAULT_GROUP_NAME, openAPIBuilder, requestBuilder, responseBuilder, operationParser, requestMappingHandlerMapping,
+			return new OpenApiResource(DEFAULT_GROUP_NAME, openAPIBuilderObjectFactory, requestBuilder, responseBuilder, operationParser, requestMappingHandlerMapping,
 					actuatorProvider,operationCustomizers, openApiCustomisers, springDocConfigProperties, springSecurityOAuth2Provider,routerFunctionProvider, repositoryRestResourceProvider);
 		}