project review

Author: springdoc

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

@@ -26,10 +26,7 @@
 import java.lang.reflect.Method;
 import java.time.Duration;
 import java.time.Instant;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -40,12 +37,12 @@ public abstract class AbstractOpenApiResource {
     private final AbstractRequestBuilder requestBuilder;
     private final AbstractResponseBuilder responseBuilder;
     private final OperationBuilder operationParser;
-    private final List<OpenApiCustomiser> openApiCustomisers;
+    private final Optional<List<OpenApiCustomiser>> openApiCustomisers;
     private boolean computeDone;
 
     protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
                                       AbstractResponseBuilder responseBuilder, OperationBuilder operationParser,
-                                      List<OpenApiCustomiser> openApiCustomisers) {
+                                      Optional<List<OpenApiCustomiser>>  openApiCustomisers) {
         super();
         this.openAPIBuilder = openAPIBuilder;
         this.requestBuilder = requestBuilder;
@@ -75,8 +72,8 @@ protected OpenAPI getOpenApi() {
             openApi = openAPIBuilder.getOpenAPI();
 
             // run the optional customisers
-            if (openApiCustomisers != null) {
-                openApiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi));
+            if (openApiCustomisers.isPresent()) {
+                openApiCustomisers.get().forEach(openApiCustomiser -> openApiCustomiser.customise(openApi));
             }
             LOGGER.info("Init duration for springdoc-openapi is: {} ms",
                     Duration.between(start, Instant.now()).toMillis());

springdoc-openapi-common/src/test/java/org/springdoc/subclass/OpenApiResource.java

@@ -10,6 +10,7 @@
 
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 
 /**
  * Class which sub class AbstractOpenApiResource in a different package and makes sure base class access is not changed.
@@ -20,7 +21,7 @@ public OpenApiResource(OpenAPIBuilder openAPIBuilder,
                            AbstractRequestBuilder requestBuilder,
                            AbstractResponseBuilder responseBuilder,
                            OperationBuilder operationParser,
-                           List<OpenApiCustomiser> openApiCustomisers) {
+                           Optional<List<OpenApiCustomiser>> openApiCustomisers) {
         super(openAPIBuilder, requestBuilder, responseBuilder, operationParser, openApiCustomisers);
     }
 

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

@@ -24,10 +24,7 @@
 import org.springframework.web.util.pattern.PathPattern;
 import reactor.core.publisher.Mono;
 
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 
 import static org.springdoc.core.Constants.*;
 import static org.springframework.util.AntPathMatcher.DEFAULT_PATH_SEPARATOR;
@@ -41,7 +38,7 @@ public class OpenApiResource extends AbstractOpenApiResource {
     public OpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
                            AbstractResponseBuilder responseBuilder, OperationBuilder operationParser,
                            RequestMappingInfoHandlerMapping requestMappingHandlerMapping,
-                           List<OpenApiCustomiser> openApiCustomisers) {
+                           Optional<List<OpenApiCustomiser>> openApiCustomisers) {
         super(openAPIBuilder, requestBuilder, responseBuilder, operationParser, openApiCustomisers);
         this.requestMappingHandlerMapping = requestMappingHandlerMapping;
     }

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

@@ -11,6 +11,7 @@
 import org.springdoc.core.AbstractResponseBuilder;
 import org.springdoc.core.OpenAPIBuilder;
 import org.springdoc.core.OperationBuilder;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.http.MediaType;
@@ -26,6 +27,7 @@
 import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
 
 import javax.servlet.http.HttpServletRequest;
+import javax.swing.text.html.Option;
 import java.util.*;
 
 import static org.springdoc.core.Constants.*;
@@ -37,15 +39,15 @@ public class OpenApiResource extends AbstractOpenApiResource {
 
     private final RequestMappingInfoHandlerMapping requestMappingHandlerMapping;
 
-    private final ActuatorProvider servletContextProvider;
+    private final Optional<ActuatorProvider> servletContextProvider;
 
     @Value(SPRINGDOC_SHOW_ACTUATOR_VALUE)
     private boolean showActuator;
 
     public OpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
                            AbstractResponseBuilder responseBuilder, OperationBuilder operationParser,
-                           RequestMappingInfoHandlerMapping requestMappingHandlerMapping, @Nullable ActuatorProvider servletContextProvider,
-                           List<OpenApiCustomiser> openApiCustomisers) {
+                           RequestMappingInfoHandlerMapping requestMappingHandlerMapping, Optional<ActuatorProvider> servletContextProvider,
+                           Optional<List<OpenApiCustomiser>> openApiCustomisers) {
         super(openAPIBuilder, requestBuilder, responseBuilder, operationParser, openApiCustomisers);
         this.requestMappingHandlerMapping = requestMappingHandlerMapping;
         this.servletContextProvider = servletContextProvider;
@@ -73,8 +75,8 @@ public String openapiYaml(HttpServletRequest request, @Value(DEFAULT_API_DOCS_UR
     protected void getPaths(Map<String, Object> restControllers) {
         Map<RequestMappingInfo, HandlerMethod> map = requestMappingHandlerMapping.getHandlerMethods();
         calculatePath(restControllers, map);
-        if (showActuator) {
-            map = servletContextProvider.getWebMvcHandlerMapping().getHandlerMethods();
+        if (showActuator && servletContextProvider.isPresent()) {
+            map = servletContextProvider.get().getWebMvcHandlerMapping().getHandlerMethods();
             Set<HandlerMethod> handlerMethods = new HashSet<>(map.values());
             this.openAPIBuilder.addTag(handlerMethods, SPRINGDOC_ACTUATOR_TAG);
             calculatePath(restControllers, map);