Support for DeferredResult. Fixes #804

Author: bnasslahsen

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

@@ -64,6 +64,7 @@
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.context.request.async.DeferredResult;
 
 import static org.springdoc.core.Constants.SPRINGDOC_DEPRECATING_CONVERTER_ENABLED;
 import static org.springdoc.core.Constants.SPRINGDOC_ENABLED;
@@ -84,7 +85,8 @@ public class SpringDocConfiguration {
 	private static final String BINDRESULT_CLASS = "org.springframework.boot.context.properties.bind.BindResult";
 
 	static {
-		getConfig().replaceWithSchema(ObjectNode.class, new ObjectSchema());
+		getConfig().replaceWithSchema(ObjectNode.class, new ObjectSchema())
+				.addResponseWrapperToIgnore(DeferredResult.class);
 	}
 
 	/**

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app129/ActualReturnedEntity.java

@@ -0,0 +1,10 @@
+package test.org.springdoc.api.app129;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class ActualReturnedEntity {
+
+	@JsonProperty
+	String result;
+
+}

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

@@ -0,0 +1,40 @@
+/*
+ *
+ *  * Copyright 2019-2020 the original author or authors.
+ *  *
+ *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  * Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  * limitations under the License.
+ *
+ */
+
+package test.org.springdoc.api.app129;
+
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.context.request.async.DeferredResult;
+
+@RestController
+@RequestMapping("/api")
+public class HelloController {
+
+	@GetMapping("/test")
+	@ApiResponses({@ApiResponse(responseCode = "200")})
+	public DeferredResult<OperationResponse<ActualReturnedEntity>> update(
+			@RequestBody ActualReturnedEntity entity) throws Exception {
+		return null;
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app129/OperationResponse.java

@@ -0,0 +1,9 @@
+package test.org.springdoc.api.app129;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class OperationResponse<T> {
+
+	@JsonProperty
+	String operationResult;
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app129/SpringDocApp129Test.java

@@ -0,0 +1,38 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
+ *  *  *
+ *  *
+ *
+ *
+ */
+package test.org.springdoc.api.app129;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+
+/**
+ * Tests Spring meta-annotations as method parameters
+ */
+public class SpringDocApp129Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

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

@@ -0,0 +1,65 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/api/test": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "update",
+        "parameters": [
+          {
+            "name": "entity",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/ActualReturnedEntity"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/OperationResponseActualReturnedEntity"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ActualReturnedEntity": {
+        "type": "object",
+        "properties": {
+          "result": {
+            "type": "string"
+          }
+        }
+      },
+      "OperationResponseActualReturnedEntity": {
+        "type": "object",
+        "properties": {
+          "operationResult": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}