Only extend defined ApiResponses with generic responses from controller advice. Fixes #429

Author: bnasslahsen

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

@@ -70,7 +70,7 @@ public class GenericResponseBuilder {
 		super();
 		this.operationBuilder = operationBuilder;
 		this.returnTypeParsers = returnTypeParsers;
-		this.springDocConfigProperties=springDocConfigProperties;
+		this.springDocConfigProperties = springDocConfigProperties;
 	}
 
 	public ApiResponses build(Components components, HandlerMethod handlerMethod, Operation operation,
@@ -125,6 +125,9 @@ private Map<String, ApiResponse> computeResponse(Components components, Method m
 		Set<io.swagger.v3.oas.annotations.responses.ApiResponse> responsesArray = getApiResponses(method);
 		if (!responsesArray.isEmpty()) {
 			methodAttributes.setWithApiResponseDoc(true);
+			if (!springDocConfigProperties.isOverrideWithGenericResponse())
+				for (String key : genericMapResponse.keySet())
+					apiResponsesOp.remove(key);
 			for (io.swagger.v3.oas.annotations.responses.ApiResponse apiResponseAnnotations : responsesArray) {
 				ApiResponse apiResponse = new ApiResponse();
 				if (StringUtils.isNotBlank(apiResponseAnnotations.ref())) {
@@ -258,7 +261,7 @@ private Schema<?> calculateSchema(Components components, Type returnType, JsonVi
 			// if void, no content
 			return null;
 		}
-		Schema<?> schemaN  = SpringDocAnnotationsUtils.extractSchema(components, returnType, jsonView);
+		Schema<?> schemaN = SpringDocAnnotationsUtils.extractSchema(components, returnType, jsonView);
 		if (schemaN == null && returnType instanceof Class && !isResponseTypeToIgnore((Class) returnType)) {
 			schemaN = AnnotationsUtils.resolveSchemaFromType((Class) returnType, null, jsonView);
 		}

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

@@ -55,6 +55,8 @@ public class SpringDocConfigProperties {
 
 	private boolean modelAndViewAllowed;
 
+	private boolean overrideWithGenericResponse = true;
+
 	private String defaultConsumesMediaType = MediaType.APPLICATION_JSON_VALUE;
 
 	private String defaultProducesMediaType = MediaType.ALL_VALUE;
@@ -303,4 +305,12 @@ public String getDefaultProducesMediaType() {
 	public void setDefaultProducesMediaType(String defaultProducesMediaType) {
 		this.defaultProducesMediaType = defaultProducesMediaType;
 	}
+
+	public boolean isOverrideWithGenericResponse() {
+		return overrideWithGenericResponse;
+	}
+
+	public void setOverrideWithGenericResponse(boolean overrideWithGenericResponse) {
+		this.overrideWithGenericResponse = overrideWithGenericResponse;
+	}
 }

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app91/GreetingController.java

@@ -1,18 +1,18 @@
 package test.org.springdoc.api.app91;
 
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.apache.commons.lang3.RandomStringUtils;
 
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
-import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
 
 @RestController
-@RequestMapping(produces = APPLICATION_JSON_VALUE)
 @Tag(name = "Demo", description = "The Demo API")
 public class GreetingController {
 
@@ -21,4 +21,13 @@ public class GreetingController {
   public ResponseEntity<Greeting> sayHello() {
     return ResponseEntity.ok(new Greeting(RandomStringUtils.randomAlphanumeric(10)));
   }
+
+	@GetMapping("/test")
+	@ApiResponses(value = { @ApiResponse(responseCode = "201", description = "item created"),
+			@ApiResponse(responseCode = "400", description = "invalid input, object invalid"),
+			@ApiResponse(responseCode = "409", description = "an existing item already exists") })
+	public ResponseEntity<Greeting> sayHello2() {
+		return ResponseEntity.ok(new Greeting(RandomStringUtils.randomAlphanumeric(10)));
+	}
+
 }

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app91/SpringDocApp91Test.java

@@ -22,7 +22,9 @@
 import test.org.springdoc.api.AbstractSpringDocTest;
 
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
 
+@TestPropertySource(properties = "springdoc.override-with-generic-response=false")
 public class SpringDocApp91Test extends AbstractSpringDocTest {
 
 	@SpringBootApplication

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

@@ -25,42 +25,42 @@
         "summary": "This API will return a random greeting.",
         "operationId": "sayHello",
         "responses": {
-          "500": {
-            "description": "Internal Server Error",
+          "400": {
+            "description": "Bad Request",
             "content": {
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/ApiError"
                 },
                 "examples": {
-                  "Service-500": {
-                    "summary": "500 from the service directly",
-                    "description": "Service-500",
+                  "Service-400": {
+                    "summary": "400 from the service directly",
+                    "description": "Service-400",
                     "value": {
-                      "status": 500,
-                      "errorCode": "ERROR_002",
-                      "message": "Another example message..."
+                      "status": 400,
+                      "errorCode": "ERROR_001",
+                      "message": "An example message..."
                     }
                   }
                 }
               }
             }
           },
-          "400": {
-            "description": "Bad Request",
+          "500": {
+            "description": "Internal Server Error",
             "content": {
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/ApiError"
                 },
                 "examples": {
-                  "Service-400": {
-                    "summary": "400 from the service directly",
-                    "description": "Service-400",
+                  "Service-500": {
+                    "summary": "500 from the service directly",
+                    "description": "Service-500",
                     "value": {
-                      "status": 400,
-                      "errorCode": "ERROR_001",
-                      "message": "An example message..."
+                      "status": 500,
+                      "errorCode": "ERROR_002",
+                      "message": "Another example message..."
                     }
                   }
                 }
@@ -79,6 +79,46 @@
           }
         }
       }
+    },
+    "/test": {
+      "get": {
+        "tags": [
+          "Demo"
+        ],
+        "operationId": "sayHello2",
+        "responses": {
+          "400": {
+            "description": "invalid input, object invalid",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/Greeting"
+                }
+              }
+            }
+          },
+          "201": {
+            "description": "item created",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/Greeting"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "an existing item already exists",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/Greeting"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {