Response schema for overridden methods of ResponseEntityExceptionHandler is not generated. Fixes #1208

bnasslahsen · bnasslahsen · commit 313214ed9af7 · 2021-09-18T02:33:16.000+02: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
@@ -298,7 +298,7 @@ protected synchronized OpenAPI getOpenApi() {
 			// run the optional customisers
 			List<Server> servers = openApi.getServers();
 			openApiCustomisers.ifPresent(apiCustomisers -> apiCustomisers.forEach(openApiCustomiser -> openApiCustomiser.customise(openApi)));
-			if(!servers.equals(openApi.getServers()))
+			if (servers != null && !servers.equals(openApi.getServers()))
 				openAPIService.setServersPresent(true);
 
 			openAPIService.setCachedOpenAPI(openApi);
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseService.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseService.java
@@ -46,13 +46,16 @@
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import org.springframework.core.MethodParameter;
 import org.springframework.core.ResolvableType;
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.http.HttpStatus;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.ReflectionUtils;
+import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseStatus;
@@ -96,6 +99,11 @@ public class GenericResponseService {
 	 */
 	private List<ControllerAdviceInfo> controllerAdviceInfos = new ArrayList<>();
 
+	/**
+	 * The constant LOGGER.
+	 */
+	private static final Logger LOGGER = LoggerFactory.getLogger(GenericResponseService.class);
+
 	/**
 	 * Instantiates a new Generic response builder.
 	 *
@@ -153,7 +161,11 @@ public void buildGenericResponse(Components components, Map<String, Object> find
 			if (org.springframework.aop.support.AopUtils.isAopProxy(controllerAdvice))
 				objClz = org.springframework.aop.support.AopUtils.getTargetClass(controllerAdvice);
 			ControllerAdviceInfo controllerAdviceInfo = new ControllerAdviceInfo(controllerAdvice);
-			Arrays.stream(ReflectionUtils.getAllDeclaredMethods(objClz)).filter(m -> m.isAnnotationPresent(ExceptionHandler.class)).forEach(methods::add);
+			Class<?> finalObjClz = objClz;
+			Arrays.stream(ReflectionUtils.getAllDeclaredMethods(objClz))
+					.filter(m -> m.isAnnotationPresent(ExceptionHandler.class)
+							|| isResponseEntityExceptionHandlerMethod(m)
+					).forEach(methods::add);
 			// for each one build ApiResponse and add it to existing responses
 			for (Method method : methods) {
 				if (!operationService.isHidden(method)) {
@@ -182,6 +194,26 @@ public void buildGenericResponse(Components components, Map<String, Object> find
 		}
 	}
 
+	/**
+	 * Is response entity exception handler method boolean.
+	 *
+	 * @param m the m
+	 * @return the boolean
+	 */
+	private boolean isResponseEntityExceptionHandlerMethod(Method m) {
+		if (AnnotatedElementUtils.hasAnnotation(m.getDeclaringClass(), ControllerAdvice.class)) {
+			try {
+				Class aClass = Class.forName("org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler");
+				if (aClass.isAssignableFrom(m.getDeclaringClass()) && ReflectionUtils.findMethod(aClass, m.getName(), m.getParameterTypes()) != null)
+					return true;
+			}
+			catch (ClassNotFoundException e) {
+				LOGGER.trace(e.getMessage());
+			}
+		}
+		return false;
+	}
+
 	/**
 	 * Compute response from doc map.
 	 *
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app59/HelloBody.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app59/HelloBody.java
@@ -0,0 +1,14 @@
+package test.org.springdoc.api.app59;
+
+import javax.validation.constraints.NotNull;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class HelloBody {
+
+    @NotNull
+	@JsonProperty
+    private String helloValue;
+
+
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app59/HelloController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app59/HelloController.java
@@ -18,7 +18,12 @@
 
 package test.org.springdoc.api.app59;
 
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
@@ -27,4 +32,10 @@ public class HelloController {
 	@GetMapping("/example")
 	public void test() {
 	}
+
+	@PostMapping("/hello")
+	@ApiResponse(responseCode = "200", description = "The server accepted your hello.")
+	String hello(@Validated @RequestBody final HelloBody helloBody) {
+		return "World!";
+	}
 }
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app59/HelloExceptionHandler.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app59/HelloExceptionHandler.java
@@ -0,0 +1,38 @@
+package test.org.springdoc.api.app59;
+
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+
+@Order(Ordered.HIGHEST_PRECEDENCE)
+@RestControllerAdvice
+public class HelloExceptionHandler extends ResponseEntityExceptionHandler {
+
+	@ExceptionHandler(Exception.class)
+	@ResponseBody
+	@ApiResponse(responseCode = "500",
+			description = "An unknown error occurred"
+	)
+	protected ResponseEntity<Object> handleException() {
+		return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
+	}
+
+	@Override
+	@ApiResponse(responseCode = "400",
+			description = "The request is malformed or information is missing."
+	)
+	protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
+		return new ResponseEntity<>(HttpStatus.BAD_REQUEST);
+	}
+
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app59.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app59.json
@@ -11,13 +11,83 @@
     }
   ],
   "paths": {
+    "/hello": {
+      "post": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "hello",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/HelloBody"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "500": {
+            "description": "An unknown error occurred",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "The request is malformed or information is missing.",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "200": {
+            "description": "The server accepted your hello.",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/example": {
       "get": {
         "tags": [
           "hello-controller"
         ],
         "operationId": "test",
         "responses": {
+          "500": {
+            "description": "An unknown error occurred",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "The request is malformed or information is missing.",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "type": "object"
+                }
+              }
+            }
+          },
           "200": {
             "description": "OK"
           }
@@ -26,5 +96,19 @@
       }
     }
   },
-  "components": {}
-}
+  "components": {
+    "schemas": {
+      "HelloBody": {
+        "required": [
+          "helloValue"
+        ],
+        "type": "object",
+        "properties": {
+          "helloValue": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}
