Merge pull request #2 from springdoc/master

joaodias14 · web-flow · commit 6c2f387139e5 · 2019-12-12T17:18:21.000Z
Update
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,8 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.2.18] - 2019-12-08
+## [Unreleased]
+
 ### Addded
 - Globally exclude params for webflux #228
 
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java
@@ -1,6 +1,7 @@
 package org.springdoc.core;
 
 import com.fasterxml.jackson.annotation.JsonView;
+import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.media.Schema;
@@ -9,6 +10,7 @@
 import org.springdoc.core.RequestInfo.ParameterType;
 import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
 import org.springframework.core.annotation.AnnotatedElementUtils;
+import org.springframework.core.annotation.AnnotationUtils;
 import org.springframework.util.CollectionUtils;
 import org.springframework.web.bind.annotation.*;
 import org.springframework.web.method.HandlerMethod;
@@ -32,6 +34,7 @@ public abstract class AbstractRequestBuilder {
     private final AbstractParameterBuilder parameterBuilder;
     private final RequestBodyBuilder requestBodyBuilder;
     private final OperationBuilder operationBuilder;
+    public static List<Class> PARAM_TYPES_TO_IGNORE = new ArrayList<>();
 
     protected AbstractRequestBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
                                      OperationBuilder operationBuilder) {
@@ -41,7 +44,9 @@ protected AbstractRequestBuilder(AbstractParameterBuilder parameterBuilder, Requ
         this.operationBuilder = operationBuilder;
     }
 
-    protected abstract boolean isParamTypeToIgnore(Class<?> paramType);
+    protected boolean isParamTypeToIgnore(Class<?> paramType){
+        return false;
+    }
 
     public Operation build(Components components, HandlerMethod handlerMethod, RequestMethod requestMethod,
                            Operation operation, MethodAttributes methodAttributes) {
@@ -110,7 +115,7 @@ protected boolean isParamToIgnore(java.lang.reflect.Parameter parameter) {
         if (parameter.isAnnotationPresent(PathVariable.class)) {
             return false;
         }
-        return parameterBuilder.isAnnotationToIgnore(parameter) || isParamTypeToIgnore(parameter.getType());
+        return parameterBuilder.isAnnotationToIgnore(parameter) || isParamTypeToIgnore(parameter.getType()) || PARAM_TYPES_TO_IGNORE.contains(parameter.getType()) || (AnnotationUtils.findAnnotation(parameter.getType(), Hidden.class) != null);
     }
 
     private void setParams(Operation operation, List<Parameter> operationParameters, RequestBodyInfo requestBodyInfo) {
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
@@ -22,6 +22,7 @@ public final class Constants {
     public static final String APPLICATION_OPENAPI_YAML = "application/vnd.oai.openapi";
     public static final String DEFAULT_SWAGGER_UI_PATH = DEFAULT_PATH_SEPARATOR + "swagger-ui.html";
     public static final String SWAGGER_UI_PATH = "${springdoc.swagger-ui.path:#{T(org.springdoc.core.Constants).DEFAULT_SWAGGER_UI_PATH}}";
+    public static final String MVC_SERVLET_PATH ="${spring.mvc.servlet.path:#{null}}";
     public static final String GET_METHOD = "get";
     public static final String POST_METHOD = "post";
     public static final String PUT_METHOD = "put";
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
@@ -95,6 +95,11 @@ public class SwaggerUiConfigProperties {
      */
     private List<String> supportedSubmitMethods;
 
+    /**
+     * OAuth redirect URL.
+     */
+    private String oauth2RedirectUrl;
+
 
     public Map<String, String> getConfigParameters() {
         final Map<String, String> params = new TreeMap<>();
@@ -115,6 +120,7 @@ public Map<String, String> getConfigParameters() {
         put("tagsSorter", tagsSorter, params);
         if (!CollectionUtils.isEmpty(supportedSubmitMethods))
             put("supportedSubmitMethods", supportedSubmitMethods.toString(), params);
+        put("oauth2RedirectUrl", oauth2RedirectUrl, params);
         return params;
     }
 
@@ -271,4 +277,12 @@ public List<String> getSupportedSubmitMethods() {
     public void setSupportedSubmitMethods(List<String> supportedSubmitMethods) {
         this.supportedSubmitMethods = supportedSubmitMethods;
     }
+
+    public String getOauth2RedirectUrl() {
+        return oauth2RedirectUrl;
+    }
+
+    public void setOauth2RedirectUrl(String oauth2RedirectUrl) {
+        this.oauth2RedirectUrl = oauth2RedirectUrl;
+    }
 }
diff --git a/springdoc-openapi-kotlin/src/main/java/org/springdoc/core/KotlinCoroutinesRequestBuilder.java b/springdoc-openapi-kotlin/src/main/java/org/springdoc/core/KotlinCoroutinesRequestBuilder.java
@@ -6,23 +6,19 @@
 import org.springframework.stereotype.Component;
 import org.springframework.web.method.HandlerMethod;
 
-import java.util.List;
-
 @Primary
 @Component
 public class KotlinCoroutinesRequestBuilder extends AbstractRequestBuilder {
 
-    private final List<AbstractRequestBuilder> requestBuilders;
 
     public KotlinCoroutinesRequestBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuilder requestBodyBuilder,
-                                          OperationBuilder operationBuilder, List<AbstractRequestBuilder> requestBuilders) {
+                                          OperationBuilder operationBuilder) {
         super(parameterBuilder, requestBodyBuilder, operationBuilder);
-        this.requestBuilders = requestBuilders;
     }
 
     @Override
     protected boolean isParamTypeToIgnore(Class<?> paramType) {
-        return paramType.isAssignableFrom(Continuation.class) || requestBuilders.stream().anyMatch(builder -> builder.isParamTypeToIgnore(paramType));
+        return paramType.isAssignableFrom(Continuation.class);
     }
 
     @Override
diff --git a/springdoc-openapi-security/src/main/java/org/springdoc/core/IgnoredParameterAnnotationsWithSecurity.java b/springdoc-openapi-security/src/main/java/org/springdoc/core/IgnoredParameterAnnotationsWithSecurity.java
@@ -1,6 +1,7 @@
 package org.springdoc.core;
 
 import org.springframework.context.annotation.Primary;
+import org.springframework.security.core.Authentication;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.stereotype.Component;
 
@@ -12,5 +13,4 @@ public class IgnoredParameterAnnotationsWithSecurity implements IgnoredParameter
     public boolean isAnnotationToIgnore(java.lang.reflect.Parameter parameter) {
         return parameter.isAnnotationPresent(AuthenticationPrincipal.class);
     }
-
 }
diff --git a/springdoc-openapi-security/src/main/java/org/springdoc/core/IgnoredParameterTypes.java b/springdoc-openapi-security/src/main/java/org/springdoc/core/IgnoredParameterTypes.java
@@ -0,0 +1,11 @@
+package org.springdoc.core;
+
+import org.springframework.security.core.Authentication;
+import org.springframework.stereotype.Component;
+
+@Component
+public class IgnoredParameterTypes {
+    static {
+        AbstractRequestBuilder.PARAM_TYPES_TO_IGNORE.add(Authentication.class);
+    }
+}
diff --git a/springdoc-openapi-security/src/test/java/test/org/springdoc/api/app2/app1/HelloController.java b/springdoc-openapi-security/src/test/java/test/org/springdoc/api/app2/app1/HelloController.java
@@ -0,0 +1,16 @@
+package test.org.springdoc.api.app2.app1;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+
+    @GetMapping
+    public Object doPost(@RequestBody String req, org.springframework.security.core.Authentication auth) {
+        return null;
+    }
+
+}
diff --git a/springdoc-openapi-security/src/test/java/test/org/springdoc/api/app2/app1/SpringDocApp2Test.java b/springdoc-openapi-security/src/test/java/test/org/springdoc/api/app2/app1/SpringDocApp2Test.java
@@ -0,0 +1,7 @@
+package test.org.springdoc.api.app2.app1;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+public class SpringDocApp2Test extends AbstractSpringDocTest {
+
+}
diff --git a/springdoc-openapi-security/src/test/java/test/org/springdoc/api/app2/app1/SpringDocTestApp.java b/springdoc-openapi-security/src/test/java/test/org/springdoc/api/app2/app1/SpringDocTestApp.java
@@ -0,0 +1,24 @@
+package test.org.springdoc.api.app2.app1;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.ComponentScan;
+
+@SpringBootApplication
+@ComponentScan(basePackages = {"org.springdoc", "test.org.springdoc.api.app2"})
+public class SpringDocTestApp {
+    public static void main(String[] args) {
+        SpringApplication.run(SpringDocTestApp.class, args);
+    }
+
+    @Bean
+    public OpenAPI customOpenAPI() {
+        return new OpenAPI()
+                .info(new Info().title("Security API").version("v1")
+                        .license(new License().name("Apache 2.0").url("http://springdoc.org")));
+    }
+}
diff --git a/springdoc-openapi-security/src/test/resources/results/app2.json b/springdoc-openapi-security/src/test/resources/results/app2.json
@@ -0,0 +1,50 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "Security API",
+    "license": {
+      "name": "Apache 2.0",
+      "url": "http://springdoc.org"
+    },
+    "version": "v1"
+  },
+  "servers": [
+    {
+      "url": "",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "doPost",
+        "parameters": [
+          {
+            "name": "req",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {}
+}
diff --git a/springdoc-openapi-ui/src/main/java/org/springdoc/ui/SwaggerWelcome.java b/springdoc-openapi-ui/src/main/java/org/springdoc/ui/SwaggerWelcome.java
@@ -1,6 +1,7 @@
 package org.springdoc.ui;
 
 import io.swagger.v3.oas.annotations.Operation;
+import org.apache.commons.lang3.StringUtils;
 import org.springdoc.core.SwaggerUiConfigProperties;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -26,19 +27,26 @@ class SwaggerWelcome {
     @Value(SWAGGER_UI_PATH)
     private String swaggerPath;
 
+    @Value(MVC_SERVLET_PATH)
+    private String mvcServletPath;
+
     @Autowired
     private SwaggerUiConfigProperties swaggerUiConfig;
 
     @Operation(hidden = true)
     @GetMapping(SWAGGER_UI_PATH)
     public String redirectToUi(HttpServletRequest request) {
         String contextPath = request.getContextPath();
+        if (StringUtils.isNotBlank(mvcServletPath))
+            contextPath += mvcServletPath;
         String uiRootPath = "";
         if (swaggerPath.contains("/")) {
             uiRootPath = swaggerPath.substring(0, swaggerPath.lastIndexOf('/'));
         }
         StringBuilder sbUrl = new StringBuilder();
         sbUrl.append(REDIRECT_URL_PREFIX);
+        if (StringUtils.isNotBlank(mvcServletPath))
+            sbUrl.append(mvcServletPath);
         sbUrl.append(uiRootPath);
         sbUrl.append(SWAGGER_UI_URL);
         if (contextPath.endsWith(DEFAULT_PATH_SEPARATOR)) {
diff --git a/springdoc-openapi-webflux-core/src/main/java/org/springdoc/core/RequestBuilder.java b/springdoc-openapi-webflux-core/src/main/java/org/springdoc/core/RequestBuilder.java
@@ -2,7 +2,6 @@
 
 import io.swagger.v3.oas.models.Operation;
 import org.springframework.http.HttpMethod;
-import org.springframework.http.server.ServerHttpResponse;
 import org.springframework.http.server.reactive.ServerHttpRequest;
 import org.springframework.stereotype.Component;
 import org.springframework.validation.BindingResult;
@@ -22,20 +21,30 @@ public RequestBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuil
         super(parameterBuilder, requestBodyBuilder, operationBuilder);
     }
 
-    @Override
-    protected boolean isParamTypeToIgnore(Class<?> paramType) {
-        return WebRequest.class.equals(paramType) || NativeWebRequest.class.equals(paramType)
-                || java.security.Principal.class.equals(paramType) || HttpMethod.class.equals(paramType)
-                || java.util.Locale.class.equals(paramType) || java.util.TimeZone.class.equals(paramType)
-                || java.time.ZoneId.class.equals(paramType) || java.io.InputStream.class.equals(paramType)
-                || java.io.Reader.class.equals(paramType) || java.io.OutputStream.class.equals(paramType)
-                || java.io.Writer.class.equals(paramType) || java.util.Map.class.equals(paramType)
-                || org.springframework.ui.Model.class.equals(paramType) || ServerHttpRequest.class.equals(paramType)
-                || org.springframework.ui.ModelMap.class.equals(paramType) || ServerHttpResponse.class.equals(paramType)
-                || Errors.class.equals(paramType) || BindingResult.class.equals(paramType) || ServerWebExchange.class.equals(paramType)
-                || SessionStatus.class.equals(paramType) || UriComponentsBuilder.class.equals(paramType);
+    static {
+        PARAM_TYPES_TO_IGNORE.add(WebRequest.class);
+        PARAM_TYPES_TO_IGNORE.add(NativeWebRequest.class);
+        PARAM_TYPES_TO_IGNORE.add(java.security.Principal.class);
+        PARAM_TYPES_TO_IGNORE.add(HttpMethod.class);
+        PARAM_TYPES_TO_IGNORE.add(java.util.Locale.class);
+        PARAM_TYPES_TO_IGNORE.add(java.util.TimeZone.class);
+        PARAM_TYPES_TO_IGNORE.add(java.io.InputStream.class);
+        PARAM_TYPES_TO_IGNORE.add(java.time.ZoneId.class);
+        PARAM_TYPES_TO_IGNORE.add(java.io.Reader.class);
+        PARAM_TYPES_TO_IGNORE.add(java.io.OutputStream.class);
+        PARAM_TYPES_TO_IGNORE.add(java.io.Writer.class);
+        PARAM_TYPES_TO_IGNORE.add(java.util.Map.class);
+        PARAM_TYPES_TO_IGNORE.add(org.springframework.ui.Model.class);
+        PARAM_TYPES_TO_IGNORE.add(ServerHttpRequest.class);
+        PARAM_TYPES_TO_IGNORE.add(org.springframework.ui.ModelMap.class);
+        PARAM_TYPES_TO_IGNORE.add(Errors.class);
+        PARAM_TYPES_TO_IGNORE.add(BindingResult.class);
+        PARAM_TYPES_TO_IGNORE.add(ServerWebExchange.class);
+        PARAM_TYPES_TO_IGNORE.add(SessionStatus.class);
+        PARAM_TYPES_TO_IGNORE.add(UriComponentsBuilder.class);
     }
 
+
     @Override
     protected Operation customiseOperation(Operation operation, HandlerMethod handlerMethod) {
         return operation;
diff --git a/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/core/RequestBuilder.java b/springdoc-openapi-webmvc-core/src/main/java/org/springdoc/core/RequestBuilder.java
@@ -20,23 +20,32 @@ public RequestBuilder(AbstractParameterBuilder parameterBuilder, RequestBodyBuil
         super(parameterBuilder, requestBodyBuilder, operationBuilder);
     }
 
-    @Override
-    protected boolean isParamTypeToIgnore(Class<?> paramType) {
-        return WebRequest.class.equals(paramType) || NativeWebRequest.class.equals(paramType)
-                || javax.servlet.ServletRequest.class.equals(paramType)
-                || javax.servlet.ServletResponse.class.equals(paramType)
-                || javax.servlet.http.HttpServletRequest.class.equals(paramType)
-                || javax.servlet.http.HttpServletResponse.class.equals(paramType)
-                || javax.servlet.http.HttpSession.class.equals(paramType)
-                || java.security.Principal.class.equals(paramType) || HttpMethod.class.equals(paramType)
-                || java.util.Locale.class.equals(paramType) || java.util.TimeZone.class.equals(paramType)
-                || java.time.ZoneId.class.equals(paramType) || java.io.InputStream.class.equals(paramType)
-                || java.io.Reader.class.equals(paramType) || java.io.OutputStream.class.equals(paramType)
-                || java.io.Writer.class.equals(paramType) || java.util.Map.class.equals(paramType)
-                || org.springframework.ui.Model.class.equals(paramType)
-                || org.springframework.ui.ModelMap.class.equals(paramType) || RedirectAttributes.class.equals(paramType)
-                || Errors.class.equals(paramType) || BindingResult.class.equals(paramType)
-                || SessionStatus.class.equals(paramType) || UriComponentsBuilder.class.equals(paramType);
+    static {
+        PARAM_TYPES_TO_IGNORE.add(WebRequest.class);
+        PARAM_TYPES_TO_IGNORE.add(NativeWebRequest.class);
+        PARAM_TYPES_TO_IGNORE.add(javax.servlet.ServletRequest.class);
+        PARAM_TYPES_TO_IGNORE.add(javax.servlet.ServletResponse.class);
+        PARAM_TYPES_TO_IGNORE.add(javax.servlet.http.HttpServletRequest.class);
+        PARAM_TYPES_TO_IGNORE.add(javax.servlet.http.HttpServletResponse.class);
+        PARAM_TYPES_TO_IGNORE.add(javax.servlet.http.HttpSession.class);
+        PARAM_TYPES_TO_IGNORE.add(java.security.Principal.class);
+        PARAM_TYPES_TO_IGNORE.add(javax.servlet.http.HttpSession.class);
+        PARAM_TYPES_TO_IGNORE.add(java.util.Locale.class);
+        PARAM_TYPES_TO_IGNORE.add(HttpMethod.class);
+        PARAM_TYPES_TO_IGNORE.add(java.util.TimeZone.class);
+        PARAM_TYPES_TO_IGNORE.add(java.time.ZoneId.class);
+        PARAM_TYPES_TO_IGNORE.add(java.io.InputStream.class);
+        PARAM_TYPES_TO_IGNORE.add(java.io.Reader.class);
+        PARAM_TYPES_TO_IGNORE.add(java.io.OutputStream.class);
+        PARAM_TYPES_TO_IGNORE.add(java.util.Map.class);
+        PARAM_TYPES_TO_IGNORE.add(org.springframework.ui.Model.class);
+        PARAM_TYPES_TO_IGNORE.add(org.springframework.ui.ModelMap.class);
+        PARAM_TYPES_TO_IGNORE.add(RedirectAttributes.class);
+        PARAM_TYPES_TO_IGNORE.add(Errors.class);
+        PARAM_TYPES_TO_IGNORE.add(BindingResult.class);
+        PARAM_TYPES_TO_IGNORE.add(SessionStatus.class);
+        PARAM_TYPES_TO_IGNORE.add(UriComponentsBuilder.class);
+        PARAM_TYPES_TO_IGNORE.add(BindingResult.class);
     }
 
     @Override
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app66/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app66/HelloController.java
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app66/SpringDocApp66Test.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app66/SpringDocApp66Test.java
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app66/SpringDocTestApp.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app66/SpringDocTestApp.java
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app66/UndocumentedClass.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app66/UndocumentedClass.java
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app66.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app66.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package org.springdoc.core;`
`2`	`2`
`3`	`3`	`import org.springframework.context.annotation.Primary;`
	`4`	`+import org.springframework.security.core.Authentication;`
`4`	`5`	`import org.springframework.security.core.annotation.AuthenticationPrincipal;`
`5`	`6`	`import org.springframework.stereotype.Component;`
`6`	`7`
`@@ -12,5 +13,4 @@ public class IgnoredParameterAnnotationsWithSecurity implements IgnoredParameter`
`12`	`13`	`public boolean isAnnotationToIgnore(java.lang.reflect.Parameter parameter) {`
`13`	`14`	`return parameter.isAnnotationPresent(AuthenticationPrincipal.class);`
`14`	`15`	`}`
`15`		`-`
`16`	`16`	`}`