Support for CompletionStage as endpoint return type. Fixes #370.

Author: mvh77

springdoc-openapi-webmvc-core/src/main/java/org/springdoc/core/ResponseBuilder.java

@@ -20,8 +20,10 @@
 
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
+import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.Callable;
+import java.util.concurrent.CompletionStage;
 
 import com.fasterxml.jackson.annotation.JsonView;
 import io.swagger.v3.oas.models.Components;
@@ -33,18 +35,21 @@
 @SuppressWarnings("rawtypes")
 public class ResponseBuilder extends AbstractResponseBuilder {
 
+	private final List<Class<?>> resultWrappers = Arrays.asList(Callable.class, CompletionStage.class);
+
 	public ResponseBuilder(OperationBuilder operationBuilder, List<ReturnTypeParser> returnTypeParsers) {
 		super(operationBuilder, returnTypeParsers);
 	}
 
 	@Override
 	protected Schema calculateSchemaFromParameterizedType(Components components, ParameterizedType parameterizedType,
-			JsonView jsonView) {
+														  JsonView jsonView) {
 		Schema<?> schemaN = null;
-		if (ResponseEntity.class.getName().contentEquals(parameterizedType.getRawType().getTypeName()) || HttpEntity.class.getName().contentEquals(parameterizedType.getRawType().getTypeName())) {
+		String parameterizedTypeName = parameterizedType.getRawType().getTypeName();
+		if (ResponseEntity.class.getName().contentEquals(parameterizedTypeName) || HttpEntity.class.getName().contentEquals(parameterizedTypeName)) {
 			schemaN = calculateSchemaParameterizedType(components, parameterizedType, jsonView);
 		}
-		else if (Callable.class.getName().contentEquals(parameterizedType.getRawType().getTypeName())) {
+		else if(resultWrappers.stream().anyMatch(clazz -> isParameterizedTypeWrapper(clazz, parameterizedType))) {
 			Type type = parameterizedType.getActualTypeArguments()[0];
 			if (type instanceof ParameterizedType) {
 				schemaN = this.calculateSchemaFromParameterizedType(components, (ParameterizedType) type, jsonView);
@@ -56,4 +61,12 @@ else if (Callable.class.getName().contentEquals(parameterizedType.getRawType().g
 		return schemaN;
 	}
 
+	private boolean isParameterizedTypeWrapper(Class<?> clazz, ParameterizedType type) {
+		try {
+			Class<?> parameterType = Class.forName(type.getRawType().getTypeName());
+			return clazz.isAssignableFrom(parameterType);
+		} catch (ClassNotFoundException e) {
+			return false;
+		}
+	}
 }

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

@@ -0,0 +1,42 @@
+/*
+ *
+ *  * 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.app76;
+
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionStage;
+
+@RestController
+public class HelloController {
+
+	@RequestMapping(value = "/person1", method = RequestMethod.GET)
+	private CompletionStage<ResponseEntity<PersonDTO>> getPerson1(String str) {
+		return null;
+	}
+
+	@RequestMapping(value = "/person2", method = RequestMethod.GET)
+	private CompletableFuture<PersonDTO> getPerson2(String str) {
+		return null;
+	}
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app76/PersonDTO.java

@@ -0,0 +1,60 @@
+/*
+ *
+ *  * 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.app76;
+
+public class PersonDTO {
+	private String email;
+
+	private String firstName;
+
+	private String lastName;
+
+	public PersonDTO() {
+	}
+
+	public PersonDTO(final String email, final String firstName, final String lastName) {
+		this.email = email;
+		this.firstName = firstName;
+		this.lastName = lastName;
+	}
+
+	public String getEmail() {
+		return email;
+	}
+
+	public void setEmail(final String email) {
+		this.email = email;
+	}
+
+	public String getFirstName() {
+		return firstName;
+	}
+
+	public void setFirstName(final String firstName) {
+		this.firstName = firstName;
+	}
+
+	public String getLastName() {
+		return lastName;
+	}
+
+	public void setLastName(final String lastName) {
+		this.lastName = lastName;
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app76/SpringDocApp76Test.java

@@ -0,0 +1,28 @@
+/*
+ *
+ *  * 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.app76;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+public class SpringDocApp76Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+}

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

@@ -0,0 +1,93 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/person1": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "getPerson1",
+        "parameters": [
+          {
+            "name": "str",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/PersonDTO"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/person2": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "getPerson2",
+        "parameters": [
+          {
+            "name": "str",
+            "in": "query",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/PersonDTO"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "PersonDTO": {
+        "type": "object",
+        "properties": {
+          "email": {
+            "type": "string"
+          },
+          "firstName": {
+            "type": "string"
+          },
+          "lastName": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}