fixes #210 #214 #209

springdoc · springdoc · commit 9d0a51126a20 · 2019-12-03T20:30:05.000+01:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java b/springdoc-openapi-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java
@@ -9,6 +9,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.*;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.CollectionUtils;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -22,6 +23,8 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import static org.springdoc.core.Constants.SPRINGDOC_PACKAGES_TO_SCAN;
+
 public abstract class AbstractOpenApiResource {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AbstractOpenApiResource.class);
@@ -31,6 +34,8 @@ public abstract class AbstractOpenApiResource {
     private final OperationBuilder operationParser;
     private final Optional<List<OpenApiCustomiser>> openApiCustomisers;
     private boolean computeDone;
+    @Value(SPRINGDOC_PACKAGES_TO_SCAN)
+    private List<String> packagesToScan;
 
     protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequestBuilder requestBuilder,
                                       AbstractResponseBuilder responseBuilder, OperationBuilder operationParser,
@@ -43,7 +48,7 @@ protected AbstractOpenApiResource(OpenAPIBuilder openAPIBuilder, AbstractRequest
         this.openApiCustomisers = openApiCustomisers;
     }
 
-    protected OpenAPI getOpenApi() {
+    protected synchronized OpenAPI getOpenApi() {
         OpenAPI openApi;
         if (!computeDone) {
             Instant start = Instant.now();
@@ -258,4 +263,8 @@ private PathItem buildPathItem(RequestMethod requestMethod, Operation operation,
         }
         return pathItemObject;
     }
+
+    protected boolean isPackageToScan(String aPackage) {
+        return CollectionUtils.isEmpty(packagesToScan) || packagesToScan.stream().filter(pack -> aPackage.equals(pack) || aPackage.startsWith(pack + ".")).findAny().isPresent();
+    }
 }
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/Constants.java
@@ -12,6 +12,7 @@ public final class Constants {
     public static final String SPRINGDOC_SWAGGER_UI_ENABLED = "springdoc.swagger-ui.enabled";
     public static final String SPRINGDOC_SHOW_ACTUATOR = "springdoc.show.actuator";
     public static final String SPRINGDOC_SHOW_ACTUATOR_VALUE = "${" + SPRINGDOC_SHOW_ACTUATOR + ":false}";
+    public static final String SPRINGDOC_PACKAGES_TO_SCAN ="${springdoc.packagesToScan:#{null}}";
     public static final String SPRINGDOC_ACTUATOR_TAG = "Actuator";
     public static final String DEFAULT_WEB_JARS_PREFIX_URL = "/webjars";
     public static final String WEB_JARS_PREFIX_URL = "${springdoc.webjars.prefix:#{T(org.springdoc.core.Constants).DEFAULT_WEB_JARS_PREFIX_URL}}";
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SpringDocConfigProperties.java
@@ -3,13 +3,17 @@
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
 
+import java.util.ArrayList;
+import java.util.List;
+
 @Configuration
 @ConfigurationProperties(prefix = "springdoc")
 public class SpringDocConfigProperties {
 
     private Boolean showActuator = false;
     private Webjars webjars = new Webjars();
     private ApiDocs apiDocs = new ApiDocs();
+    private List<String> packagesToScan;
 
     public static class Webjars {
         private String prefix = "/webjars";
@@ -50,6 +54,14 @@ public void setEnabled(Boolean enabled) {
         }
     }
 
+    public List<String> getPackagesToScan() {
+        return packagesToScan;
+    }
+
+    public void setPackagesToScan(List<String> packagesToScan) {
+        this.packagesToScan = packagesToScan;
+    }
+
     public Boolean getShowActuator() {
         return showActuator;
     }
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/SwaggerUiConfigProperties.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/SwaggerUiConfigProperties.java
@@ -4,7 +4,9 @@
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.util.CollectionUtils;
 
+import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;
 
@@ -88,6 +90,12 @@ public class SwaggerUiConfigProperties {
      */
     private Boolean showCommonExtensions;
 
+    /**
+     * The supported try it out methods
+     */
+    private List<String> supportedSubmitMethods;
+
+
     public Map<String, String> getConfigParameters() {
         final Map<String, String> params = new TreeMap<>();
         put("layout", layout, params);
@@ -105,6 +113,8 @@ public Map<String, String> getConfigParameters() {
         put("showCommonExtensions", showCommonExtensions, params);
         put("operationsSorter", operationsSorter, params);
         put("tagsSorter", tagsSorter, params);
+        if (!CollectionUtils.isEmpty(supportedSubmitMethods))
+            put("supportedSubmitMethods", supportedSubmitMethods.toString(), params);
         return params;
     }
 
@@ -253,4 +263,12 @@ public Boolean getShowCommonExtensions() {
     public void setShowCommonExtensions(Boolean showCommonExtensions) {
         this.showCommonExtensions = showCommonExtensions;
     }
+
+    public List<String> getSupportedSubmitMethods() {
+        return supportedSubmitMethods;
+    }
+
+    public void setSupportedSubmitMethods(List<String> supportedSubmitMethods) {
+        this.supportedSubmitMethods = supportedSubmitMethods;
+    }
 }
diff --git a/springdoc-openapi-webflux-core/src/main/java/org/springdoc/api/OpenApiResource.java b/springdoc-openapi-webflux-core/src/main/java/org/springdoc/api/OpenApiResource.java
@@ -74,7 +74,7 @@ protected void getPaths(Map<String, Object> restControllers) {
                 Map<String, String> regexMap = new LinkedHashMap<>();
                 operationPath = PathUtils.parsePath(operationPath, regexMap);
                 if (operationPath.startsWith(DEFAULT_PATH_SEPARATOR)
-                        && restControllers.containsKey(handlerMethod.getBean().toString())) {
+                        && restControllers.containsKey(handlerMethod.getBean().toString()) && isPackageToScan(handlerMethod.getBeanType().getPackage().getName())) {
                     Set<RequestMethod> requestMethods = requestMappingInfo.getMethodsCondition().getMethods();
                     calculatePath(openAPIBuilder, handlerMethod, operationPath, requestMethods);
                 }
diff --git a/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app63/HelloController.java b/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app63/HelloController.java
@@ -0,0 +1,13 @@
+package test.org.springdoc.api.app63;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+    @GetMapping("/test")
+    public void test(String hello) {
+    }
+
+}
diff --git a/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app63/SpringDocApp63Test.java b/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app63/SpringDocApp63Test.java
@@ -0,0 +1,19 @@
+package test.org.springdoc.api.app63;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.springframework.context.annotation.ComponentScan;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+public class SpringDocApp63Test extends AbstractSpringDocTest {
+
+    @BeforeClass
+    public static void beforeClass() {
+        System.setProperty("springdoc.packagesToScan", "hell,hello1, hello.me");
+    }
+
+    @AfterClass
+    public static void afterClass() {
+        System.clearProperty("springdoc.packagesToScan");
+    }
+}
diff --git a/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app63/SpringDocTestApp.java b/springdoc-openapi-webflux-core/src/test/java/test/org/springdoc/api/app63/SpringDocTestApp.java
@@ -0,0 +1,14 @@
+package test.org.springdoc.api.app63;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.ComponentScan;
+
+@SpringBootApplication
+@ComponentScan(basePackages = {"org.springdoc", "test.org.springdoc.api.app63"})
+public class SpringDocTestApp {
+
+    public static void main(String[] args) {
+        SpringApplication.run(SpringDocTestApp.class, args);
+    }
+}
diff --git a/springdoc-openapi-webflux-core/src/test/resources/results/app63.json b/springdoc-openapi-webflux-core/src/test/resources/results/app63.json
@@ -0,0 +1,15 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {},
+  "components": {}
+}
diff --git a/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/api/OpenApiResource.java b/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/api/OpenApiResource.java
@@ -89,7 +89,7 @@ private void calculatePath(Map<String, Object> restControllers, Map<RequestMappi
             String operationPath = CollectionUtils.isEmpty(patterns) ? "/" : patterns.iterator().next();
             Map<String, String> regexMap = new LinkedHashMap<>();
             operationPath = PathUtils.parsePath(operationPath, regexMap);
-            if (isRestController(restControllers, handlerMethod, operationPath)) {
+            if (isRestController(restControllers, handlerMethod, operationPath) && isPackageToScan(handlerMethod.getBeanType().getPackage().getName())) {
                 Set<RequestMethod> requestMethods = requestMappingInfo.getMethodsCondition().getMethods();
                 calculatePath(openAPIBuilder, handlerMethod, operationPath, requestMethods);
             }
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app36/SpringDocApp36Test.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app36/SpringDocApp36Test.java
@@ -18,10 +18,9 @@
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
 @RunWith(SpringRunner.class)
-@SpringBootTest
+@SpringBootTest(properties = "springdoc.show.actuator=true")
 @ActiveProfiles("test")
 @AutoConfigureMockMvc
-@TestPropertySource("classpath:/properties/36.properties")
 public class SpringDocApp36Test {
 
 
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app36/SpringDocTestApp.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app36/SpringDocTestApp.java
@@ -2,6 +2,7 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.test.context.SpringBootTest;
 
 @SpringBootApplication
 public class SpringDocTestApp {
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app63/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app63/HelloController.java
@@ -0,0 +1,25 @@
+package test.org.springdoc.api.app63;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.enums.ParameterIn;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import javax.servlet.http.HttpSession;
+import java.util.Locale;
+
+@RestController
+public class HelloController {
+
+    @GetMapping("/test")
+    public void test(HttpSession header, HttpServletRequest request, HttpServletResponse response, Locale locale,
+                     String hello) {
+    }
+
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app63/SpringDocApp63Test.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app63/SpringDocApp63Test.java
@@ -0,0 +1,18 @@
+package test.org.springdoc.api.app63;
+
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+public class SpringDocApp63Test extends AbstractSpringDocTest {
+
+    @BeforeClass
+    public static void beforeClass() {
+        System.setProperty("springdoc.packagesToScan", "hell,hello1, hello.me");
+    }
+
+    @AfterClass
+    public static void afterClass() {
+        System.clearProperty("springdoc.packagesToScan");
+    }
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app63/SpringDocTestApp.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app63/SpringDocTestApp.java
@@ -0,0 +1,14 @@
+package test.org.springdoc.api.app63;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.TestPropertySource;
+
+@SpringBootApplication
+public class SpringDocTestApp {
+
+    public static void main(String[] args) {
+        SpringApplication.run(SpringDocTestApp.class, args);
+    }
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/properties/36.properties b/springdoc-openapi-webmvc-core/src/test/resources/properties/36.properties
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app63.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app63.json
@@ -0,0 +1,15 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {},
+  "components": {}
+}

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ protected void getPaths(Map<String, Object> restControllers) {`
`74`	`74`	`Map<String, String> regexMap = new LinkedHashMap<>();`
`75`	`75`	`operationPath = PathUtils.parsePath(operationPath, regexMap);`
`76`	`76`	`if (operationPath.startsWith(DEFAULT_PATH_SEPARATOR)`
`77`		`- && restControllers.containsKey(handlerMethod.getBean().toString())) {`
	`77`	`+ && restControllers.containsKey(handlerMethod.getBean().toString()) && isPackageToScan(handlerMethod.getBeanType().getPackage().getName())) {`
`78`	`78`	`Set<RequestMethod> requestMethods = requestMappingInfo.getMethodsCondition().getMethods();`
`79`	`79`	`calculatePath(openAPIBuilder, handlerMethod, operationPath, requestMethods);`
`80`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ private void calculatePath(Map<String, Object> restControllers, Map<RequestMappi`
`89`	`89`	`String operationPath = CollectionUtils.isEmpty(patterns) ? "/" : patterns.iterator().next();`
`90`	`90`	`Map<String, String> regexMap = new LinkedHashMap<>();`
`91`	`91`	`operationPath = PathUtils.parsePath(operationPath, regexMap);`
`92`		`- if (isRestController(restControllers, handlerMethod, operationPath)) {`
	`92`	`+ if (isRestController(restControllers, handlerMethod, operationPath) && isPackageToScan(handlerMethod.getBeanType().getPackage().getName())) {`
`93`	`93`	`Set<RequestMethod> requestMethods = requestMappingInfo.getMethodsCondition().getMethods();`
`94`	`94`	`calculatePath(openAPIBuilder, handlerMethod, operationPath, requestMethods);`
`95`	`95`	`}`