Merge pull request #503 from joaodias14/feature/502-ignore-subtypes

#502 - Also ignore subtypes of configured classes to be ignored on Controllers

Author: bnasslahsen

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

@@ -257,7 +257,7 @@ protected boolean isParamToIgnore(MethodParameter parameter) {
 			return true;
 		if (parameter.getParameterAnnotation(PathVariable.class) != null || parameter.getParameterAnnotation(RequestParam.class) != null)
 			return false;
-		return PARAM_TYPES_TO_IGNORE.contains(parameter.getParameterType());
+		return PARAM_TYPES_TO_IGNORE.stream().anyMatch(paramToIgnore -> paramToIgnore.isAssignableFrom(parameter.getParameterType()));
 	}
 
 	private void setParams(Operation operation, List<Parameter> operationParameters, RequestBodyInfo requestBodyInfo) {

springdoc-openapi-security/src/test/java/test/org/springdoc/api/app2/HelloController.java

@@ -18,17 +18,31 @@
 
 package test.org.springdoc.api.app2;
 
+import org.springframework.security.core.Authentication;
 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("oneParameterAndAuthentication")
+	public Object oneParameterAndAuthentication(@RequestBody String req, Authentication authentication) {
+		return null;
+	}
 
-	@GetMapping
-	public Object doPost(@RequestBody String req, org.springframework.security.core.Authentication auth) {
+	@GetMapping("noParametersAndAuthentication")
+	public Object noParametersAndAuthentication(Authentication authentication) {
 		return null;
 	}
 
+	@GetMapping("oneParameterAndUser")
+	public Object oneParameterAndUser(@RequestBody String req, User user) {
+		return null;
+	}
+
+	@GetMapping("noParametersAndUser")
+	public Object noParametersAndUser(User user) {
+		return null;
+	}
 }

springdoc-openapi-security/src/test/java/test/org/springdoc/api/app2/User.java

@@ -0,0 +1,43 @@
+package test.org.springdoc.api.app2;
+
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.GrantedAuthority;
+
+import java.util.Collection;
+
+public class User implements Authentication {
+    @Override
+    public Collection<? extends GrantedAuthority> getAuthorities() {
+        return null;
+    }
+
+    @Override
+    public Object getCredentials() {
+        return null;
+    }
+
+    @Override
+    public Object getDetails() {
+        return null;
+    }
+
+    @Override
+    public Object getPrincipal() {
+        return null;
+    }
+
+    @Override
+    public boolean isAuthenticated() {
+        return false;
+    }
+
+    @Override
+    public void setAuthenticated(boolean isAuthenticated) throws IllegalArgumentException {
+
+    }
+
+    @Override
+    public String getName() {
+        return null;
+    }
+}

springdoc-openapi-security/src/test/resources/results/app2.json

@@ -15,12 +15,13 @@
     }
   ],
   "paths": {
-    "/": {
+    "/oneParameterAndAuthentication": {
       "get": {
         "tags": [
           "hello-controller"
         ],
         "operationId": "doPost",
+        "operationId": "oneParameterAndAuthentication",
         "parameters": [
           {
             "name": "req",
@@ -44,6 +45,76 @@
           }
         }
       }
+    },
+    "/noParametersAndAuthentication": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "noParametersAndAuthentication",
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/oneParameterAndUser": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "oneParameterAndUser",
+        "parameters": [
+          {
+            "name": "req",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/noParametersAndUser": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "noParametersAndUser",
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {}