Added support for @JSONVIEW on ExceptionHandlers methods

Author: Malkeet Singh

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

@@ -38,6 +38,7 @@
 
 import com.fasterxml.jackson.annotation.JsonView;
 import io.swagger.v3.core.util.AnnotationsUtils;
+import io.swagger.v3.core.util.ReflectionUtils;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.media.Content;
@@ -53,6 +54,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.util.CollectionUtils;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.method.ControllerAdviceBean;
@@ -165,6 +167,8 @@ public void buildGenericResponse(Components components, Map<String, Object> find
 					ApiResponses apiResponsesOp = new ApiResponses();
 					MethodAttributes methodAttributes = new MethodAttributes(methodProduces, springDocConfigProperties.getDefaultConsumesMediaType(),
 							springDocConfigProperties.getDefaultProducesMediaType(), controllerAdviceInfoApiResponseMap);
+					//calculate JsonView Annotation
+					methodAttributes.setJsonViewAnnotation(AnnotatedElementUtils.findMergedAnnotation(method, JsonView.class));
 					Map<String, ApiResponse> apiResponses = computeResponseFromDoc(components, methodParameter, apiResponsesOp, methodAttributes);
 					buildGenericApiResponses(components, methodParameter, apiResponsesOp, methodAttributes);
 					apiResponses.forEach(controllerAdviceInfoApiResponseMap::put);

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app157/CustomException.java

@@ -0,0 +1,7 @@
+package test.org.springdoc.api.app157;
+
+public class CustomException extends RuntimeException{
+    public CustomException(String message) {
+        super(message);
+    }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app157/FooBean.java

@@ -0,0 +1,31 @@
+package test.org.springdoc.api.app157;
+
+import com.fasterxml.jackson.annotation.JsonView;
+
+public class FooBean {
+    @JsonView(Views.View2.class)
+    private String message;
+    @JsonView(Views.View1.class)
+    private int code;
+
+    public String getMessage() {
+        return message;
+    }
+
+    public void setMessage(String message) {
+        this.message = message;
+    }
+
+    public int getCode() {
+        return code;
+    }
+
+    public void setCode(int code) {
+        this.code = code;
+    }
+
+    public FooBean(String message, int code) {
+        this.message = message;
+        this.code = code;
+    }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app157/FooErrorHandler.java

@@ -0,0 +1,26 @@
+package test.org.springdoc.api.app157;
+
+import com.fasterxml.jackson.annotation.JsonView;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ControllerAdvice(assignableTypes = HelloController.class)
+public class FooErrorHandler {
+
+	@ExceptionHandler
+	@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
+	@JsonView(Views.View1.class)
+	public ResponseEntity<FooBean> storeAssignmentPublishingError(Exception e) {
+		return new ResponseEntity<>(new FooBean("INTERNAL_SERVER_ERROR",500), HttpStatus.INTERNAL_SERVER_ERROR);
+	}
+
+	@ExceptionHandler
+	@ResponseStatus(value = HttpStatus.BAD_REQUEST)
+	@JsonView(Views.View2.class)
+	public ResponseEntity<FooBean> storeAssignmentPublishingError(CustomException e) {
+		return new ResponseEntity<>(new FooBean("BAD Request",400), HttpStatus.BAD_REQUEST);
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app157/HelloController.java

@@ -0,0 +1,22 @@
+package test.org.springdoc.api.app157;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.info.Info;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api")
+@OpenAPIDefinition(info = @Info(title = "API Examples", version = "1.0"), tags = @Tag(name = "Operations"))
+public class HelloController {
+
+	@PostMapping("/foo")
+	public String create(@RequestBody String foo) {
+		return "foo";
+	}
+}
+
+

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app157/SpringDocApp157Test.java

@@ -0,0 +1,12 @@
+package test.org.springdoc.api.app157;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+
+public class SpringDocApp157Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app157/Views.java

@@ -0,0 +1,8 @@
+package test.org.springdoc.api.app157;
+
+public class Views {
+    public static class View1 {
+    }
+    public static class View2 extends View1 {
+    }
+}

springdoc-openapi-webmvc-core/src/test/resources/results/app157.json

@@ -0,0 +1,95 @@
+{
+  "openapi":"3.0.1",
+  "info":{
+    "title":"API Examples",
+    "version":"1.0"
+  },
+  "servers":[
+    {
+      "url":"http://localhost",
+      "description":"Generated server url"
+    }
+  ],
+  "tags":[
+    {
+      "name":"Operations"
+    }
+  ],
+  "paths":{
+    "/api/foo":{
+      "post":{
+        "tags":[
+          "hello-controller"
+        ],
+        "operationId":"create",
+        "requestBody":{
+          "content":{
+            "application/json":{
+              "schema":{
+                "type":"string"
+              }
+            }
+          },
+          "required":true
+        },
+        "responses":{
+          "500":{
+            "description":"Internal Server Error",
+            "content":{
+              "*/*":{
+                "schema":{
+                  "$ref":"#/components/schemas/FooBean_View1"
+                }
+              }
+            }
+          },
+          "400":{
+            "description":"Bad Request",
+            "content":{
+              "*/*":{
+                "schema":{
+                  "$ref":"#/components/schemas/FooBean_View2"
+                }
+              }
+            }
+          },
+          "200":{
+            "description":"OK",
+            "content":{
+              "*/*":{
+                "schema":{
+                  "type":"string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components":{
+    "schemas":{
+      "FooBean_View1":{
+        "type":"object",
+        "properties":{
+          "code":{
+            "type":"integer",
+            "format":"int32"
+          }
+        }
+      },
+      "FooBean_View2":{
+        "type":"object",
+        "properties":{
+          "message":{
+            "type":"string"
+          },
+          "code":{
+            "type":"integer",
+            "format":"int32"
+          }
+        }
+      }
+    }
+  }
+}