Added support for generic controller types parameters

bnasslahsen · bnasslahsen · commit 80e33472eb83 · 2020-03-01T21:49:25.000+01:00
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/AbstractRequestBuilder.java
@@ -184,7 +184,7 @@ else if (!RequestMethod.GET.equals(requestMethod)) {
 					requestBodyBuilder.calculateRequestBodyInfo(components, handlerMethod, methodAttributes, i,
 							parameterInfo, requestBodyInfo);
 				}
-				parameter = customiseParameter(parameter, parameterInfo, handlerMethod);
+				customiseParameter(parameter, parameterInfo, handlerMethod);
 			}
 		}
 
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/GenericResponseBuilder.java
@@ -82,7 +82,7 @@ public ApiResponses build(Components components, HandlerMethod handlerMethod, Op
 			apiResponsesFromDoc.forEach(apiResponses::addApiResponse);
 		// for each one build ApiResponse and add it to existing responses
 		// Fill api Responses
-		computeResponse(components, handlerMethod.getMethod(), apiResponses, methodAttributes, false);
+		computeResponse(components, handlerMethod.getMethod(), handlerMethod.getReturnType().getParameterType(), apiResponses, methodAttributes, false);
 		return apiResponses;
 	}
 
@@ -97,7 +97,7 @@ public void buildGenericResponse(Components components, Map<String, Object> find
 				if (reqMappringMethod != null) {
 					methodProduces = reqMappringMethod.produces();
 				}
-				Map<String, ApiResponse> apiResponses = computeResponse(components, method, new ApiResponses(),
+				Map<String, ApiResponse> apiResponses = computeResponse(components, method,null, new ApiResponses(),
 						new MethodAttributes(methodProduces, springDocConfigProperties.getDefaultConsumesMediaType(), springDocConfigProperties.getDefaultProducesMediaType()), true);
 				apiResponses.forEach(genericMapResponse::put);
 			}
@@ -118,7 +118,7 @@ private List<Method> getMethods(Map<String, Object> findControllerAdvice) {
 		return methods;
 	}
 
-	private Map<String, ApiResponse> computeResponse(Components components, Method method, ApiResponses apiResponsesOp,
+	private Map<String, ApiResponse> computeResponse(Components components, Method method,  Class<?>  clazz, ApiResponses apiResponsesOp,
 			MethodAttributes methodAttributes, boolean isGeneric) {
 		// Parsing documentation, if present
 		Set<io.swagger.v3.oas.annotations.responses.ApiResponse> responsesArray = getApiResponses(method);
@@ -146,7 +146,7 @@ private Map<String, ApiResponse> computeResponse(Components components, Method m
 				apiResponsesOp.addApiResponse(apiResponseAnnotations.responseCode(), apiResponse);
 			}
 		}
-		buildApiResponses(components, method, apiResponsesOp, methodAttributes, isGeneric);
+		buildApiResponses(components, method, clazz, apiResponsesOp, methodAttributes, isGeneric);
 		return apiResponsesOp;
 	}
 
@@ -174,14 +174,14 @@ private void buildContentFromDoc(Components components, ApiResponses apiResponse
 		}
 	}
 
-	private void buildApiResponses(Components components, Method method, ApiResponses apiResponsesOp,
+	private void buildApiResponses(Components components, Method method,  Class<?>  clazz, ApiResponses apiResponsesOp,
 			MethodAttributes methodAttributes, boolean isGeneric) {
 		if (!CollectionUtils.isEmpty(apiResponsesOp) && (apiResponsesOp.size() != genericMapResponse.size() || isGeneric)) {
 			// API Responses at operation and @ApiResponse annotation
 			for (Map.Entry<String, ApiResponse> entry : apiResponsesOp.entrySet()) {
 				String httpCode = entry.getKey();
 				ApiResponse apiResponse = entry.getValue();
-				buildApiResponses(components, method, apiResponsesOp, methodAttributes, httpCode, apiResponse,
+				buildApiResponses(components, method, clazz, apiResponsesOp, methodAttributes, httpCode, apiResponse,
 						isGeneric);
 			}
 		}
@@ -192,7 +192,7 @@ private void buildApiResponses(Components components, Method method, ApiResponse
 			ApiResponse apiResponse = genericMapResponse.containsKey(httpCode) ? genericMapResponse.get(httpCode)
 					: new ApiResponse();
 			if (httpCode != null)
-				buildApiResponses(components, method, apiResponsesOp, methodAttributes, httpCode, apiResponse,
+				buildApiResponses(components, method, clazz, apiResponsesOp, methodAttributes, httpCode, apiResponse,
 						isGeneric);
 		}
 	}
@@ -222,9 +222,9 @@ private Set<io.swagger.v3.oas.annotations.responses.ApiResponse> getApiResponses
 		return responses;
 	}
 
-	private Content buildContent(Components components, Method method, String[] methodProduces, JsonView jsonView) {
+	private Content buildContent(Components components, Method method, Class<?>  clazz, String[] methodProduces, JsonView jsonView) {
 		Content content = new Content();
-		Type returnType = getReturnType(method);
+		Type returnType = getReturnType(method,clazz);
 		if (isVoid(returnType)) {
 			// if void, no content
 			content = null;
@@ -241,11 +241,11 @@ else if (ArrayUtils.isNotEmpty(methodProduces)) {
 		return content;
 	}
 
-	private Type getReturnType(Method method) {
+	private Type getReturnType(Method method,Class<?>  clazz) {
 		Type returnType = Object.class;
 		for (ReturnTypeParser returnTypeParser : returnTypeParsers) {
 			if (returnType.getTypeName().equals(Object.class.getTypeName())) {
-				returnType = returnTypeParser.getReturnType(method);
+				returnType = returnTypeParser.getReturnType(method,clazz);
 			}
 			else {
 				break;
@@ -272,12 +272,12 @@ private void setContent(String[] methodProduces, Content content,
 		Arrays.stream(methodProduces).forEach(mediaTypeStr -> content.addMediaType(mediaTypeStr, mediaType));
 	}
 
-	private void buildApiResponses(Components components, Method method, ApiResponses apiResponsesOp,
+	private void buildApiResponses(Components components, Method method, Class<?>  clazz, ApiResponses apiResponsesOp,
 			MethodAttributes methodAttributes, String httpCode, ApiResponse apiResponse, boolean isGeneric) {
 		// No documentation
 		if (StringUtils.isBlank(apiResponse.get$ref())) {
 			if (apiResponse.getContent() == null) {
-				Content content = buildContent(components, method, methodAttributes.getMethodProduces(),
+				Content content = buildContent(components, method,clazz, methodAttributes.getMethodProduces(),
 						methodAttributes.getJsonViewAnnotation());
 				apiResponse.setContent(content);
 			}
diff --git a/springdoc-openapi-common/src/main/java/org/springdoc/core/ReturnTypeParser.java b/springdoc-openapi-common/src/main/java/org/springdoc/core/ReturnTypeParser.java
@@ -19,11 +19,15 @@
 package org.springdoc.core;
 
 import java.lang.reflect.Method;
+import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
 
 interface ReturnTypeParser {
-	default Type getReturnType(Method method) {
-		return method.getGenericReturnType();
+
+	default Type getReturnType(Method method, Class<?>  clazz) {
+		if( method.getGenericReturnType() instanceof ParameterizedType || clazz==null)
+			return method.getGenericReturnType();
+		return clazz;
 	}
 }
 
diff --git a/springdoc-openapi-kotlin/src/main/java/org/springdoc/core/KotlinCoroutinesReturnTypeParser.java b/springdoc-openapi-kotlin/src/main/java/org/springdoc/core/KotlinCoroutinesReturnTypeParser.java
@@ -31,7 +31,7 @@
 public class KotlinCoroutinesReturnTypeParser implements ReturnTypeParser {
 
 	@Override
-	public Type getReturnType(Method method) {
+	public Type getReturnType(Method method, Class<?>  clazz) {
 		Type returnType = Object.class;
 		Optional<Parameter> continuationParameter = Arrays.stream(method.getParameters())
 				.filter(parameter -> parameter.getType().getCanonicalName().equals(Continuation.class.getCanonicalName()))
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/BaseClientModel.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/BaseClientModel.java
@@ -0,0 +1,8 @@
+package test.org.springdoc.api.app93;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public abstract class BaseClientModel {
+	@JsonProperty("id")
+	int id;
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/BaseController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/BaseController.java
@@ -0,0 +1,13 @@
+package test.org.springdoc.api.app93;
+
+import io.swagger.v3.oas.annotations.Operation;
+
+import org.springframework.web.bind.annotation.GetMapping;
+
+public abstract class BaseController<TClientModel extends BaseClientModel> {
+	@Operation
+	@GetMapping
+	TClientModel get() {
+		return null;
+	}
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/SpecificClientModel.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/SpecificClientModel.java
@@ -0,0 +1,8 @@
+package test.org.springdoc.api.app93;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class SpecificClientModel extends BaseClientModel {
+	@JsonProperty("name")
+	String name;
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/SpecificController.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/SpecificController.java
@@ -0,0 +1,6 @@
+package test.org.springdoc.api.app93;
+
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class SpecificController extends BaseController<SpecificClientModel> {}
diff --git a/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/SpringDocApp93Test.java b/springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app93/SpringDocApp93Test.java
@@ -0,0 +1,31 @@
+/*
+ *
+ *  * 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.app93;
+
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp93Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}
diff --git a/springdoc-openapi-webmvc-core/src/test/resources/results/app93.json b/springdoc-openapi-webmvc-core/src/test/resources/results/app93.json
@@ -0,0 +1,51 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/": {
+      "get": {
+        "tags": [
+          "specific-controller"
+        ],
+        "operationId": "get",
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/SpecificClientModel"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "SpecificClientModel": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "name": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@ else if (!RequestMethod.GET.equals(requestMethod)) {`
`184`	`184`	`requestBodyBuilder.calculateRequestBodyInfo(components, handlerMethod, methodAttributes, i,`
`185`	`185`	`parameterInfo, requestBodyInfo);`
`186`	`186`	`}`
`187`		`- parameter = customiseParameter(parameter, parameterInfo, handlerMethod);`
	`187`	`+ customiseParameter(parameter, parameterInfo, handlerMethod);`
`188`	`188`	`}`
`189`	`189`	`}`
`190`	`190`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ public ApiResponses build(Components components, HandlerMethod handlerMethod, Op`
`82`	`82`	`apiResponsesFromDoc.forEach(apiResponses::addApiResponse);`
`83`	`83`	`// for each one build ApiResponse and add it to existing responses`
`84`	`84`	`// Fill api Responses`
`85`		`- computeResponse(components, handlerMethod.getMethod(), apiResponses, methodAttributes, false);`
	`85`	`+ computeResponse(components, handlerMethod.getMethod(), handlerMethod.getReturnType().getParameterType(), apiResponses, methodAttributes, false);`
`86`	`86`	`return apiResponses;`
`87`	`87`	`}`
`88`	`88`
`@@ -97,7 +97,7 @@ public void buildGenericResponse(Components components, Map<String, Object> find`
`97`	`97`	`if (reqMappringMethod != null) {`
`98`	`98`	`methodProduces = reqMappringMethod.produces();`
`99`	`99`	`}`
`100`		`- Map<String, ApiResponse> apiResponses = computeResponse(components, method, new ApiResponses(),`
	`100`	`+ Map<String, ApiResponse> apiResponses = computeResponse(components, method,null, new ApiResponses(),`
`101`	`101`	`new MethodAttributes(methodProduces, springDocConfigProperties.getDefaultConsumesMediaType(), springDocConfigProperties.getDefaultProducesMediaType()), true);`
`102`	`102`	`apiResponses.forEach(genericMapResponse::put);`
`103`	`103`	`}`
`@@ -118,7 +118,7 @@ private List<Method> getMethods(Map<String, Object> findControllerAdvice) {`
`118`	`118`	`return methods;`
`119`	`119`	`}`
`120`	`120`
`121`		`- private Map<String, ApiResponse> computeResponse(Components components, Method method, ApiResponses apiResponsesOp,`
	`121`	`+ private Map<String, ApiResponse> computeResponse(Components components, Method method, Class<?> clazz, ApiResponses apiResponsesOp,`
`122`	`122`	`MethodAttributes methodAttributes, boolean isGeneric) {`
`123`	`123`	`// Parsing documentation, if present`
`124`	`124`	`Set<io.swagger.v3.oas.annotations.responses.ApiResponse> responsesArray = getApiResponses(method);`
`@@ -146,7 +146,7 @@ private Map<String, ApiResponse> computeResponse(Components components, Method m`
`146`	`146`	`apiResponsesOp.addApiResponse(apiResponseAnnotations.responseCode(), apiResponse);`
`147`	`147`	`}`
`148`	`148`	`}`
`149`		`- buildApiResponses(components, method, apiResponsesOp, methodAttributes, isGeneric);`
	`149`	`+ buildApiResponses(components, method, clazz, apiResponsesOp, methodAttributes, isGeneric);`
`150`	`150`	`return apiResponsesOp;`
`151`	`151`	`}`
`152`	`152`
`@@ -174,14 +174,14 @@ private void buildContentFromDoc(Components components, ApiResponses apiResponse`
`174`	`174`	`}`
`175`	`175`	`}`
`176`	`176`
`177`		`- private void buildApiResponses(Components components, Method method, ApiResponses apiResponsesOp,`
	`177`	`+ private void buildApiResponses(Components components, Method method, Class<?> clazz, ApiResponses apiResponsesOp,`
`178`	`178`	`MethodAttributes methodAttributes, boolean isGeneric) {`
`179`	`179`	`if (!CollectionUtils.isEmpty(apiResponsesOp) && (apiResponsesOp.size() != genericMapResponse.size() \|\| isGeneric)) {`
`180`	`180`	`// API Responses at operation and @ApiResponse annotation`
`181`	`181`	`for (Map.Entry<String, ApiResponse> entry : apiResponsesOp.entrySet()) {`
`182`	`182`	`String httpCode = entry.getKey();`
`183`	`183`	`ApiResponse apiResponse = entry.getValue();`
`184`		`- buildApiResponses(components, method, apiResponsesOp, methodAttributes, httpCode, apiResponse,`
	`184`	`+ buildApiResponses(components, method, clazz, apiResponsesOp, methodAttributes, httpCode, apiResponse,`
`185`	`185`	`isGeneric);`
`186`	`186`	`}`
`187`	`187`	`}`
`@@ -192,7 +192,7 @@ private void buildApiResponses(Components components, Method method, ApiResponse`
`192`	`192`	`ApiResponse apiResponse = genericMapResponse.containsKey(httpCode) ? genericMapResponse.get(httpCode)`
`193`	`193`	`: new ApiResponse();`
`194`	`194`	`if (httpCode != null)`
`195`		`- buildApiResponses(components, method, apiResponsesOp, methodAttributes, httpCode, apiResponse,`
	`195`	`+ buildApiResponses(components, method, clazz, apiResponsesOp, methodAttributes, httpCode, apiResponse,`
`196`	`196`	`isGeneric);`
`197`	`197`	`}`
`198`	`198`	`}`
`@@ -222,9 +222,9 @@ private Set<io.swagger.v3.oas.annotations.responses.ApiResponse> getApiResponses`
`222`	`222`	`return responses;`
`223`	`223`	`}`
`224`	`224`
`225`		`- private Content buildContent(Components components, Method method, String[] methodProduces, JsonView jsonView) {`
	`225`	`+ private Content buildContent(Components components, Method method, Class<?> clazz, String[] methodProduces, JsonView jsonView) {`
`226`	`226`	`Content content = new Content();`
`227`		`- Type returnType = getReturnType(method);`
	`227`	`+ Type returnType = getReturnType(method,clazz);`
`228`	`228`	`if (isVoid(returnType)) {`
`229`	`229`	`// if void, no content`
`230`	`230`	`content = null;`
`@@ -241,11 +241,11 @@ else if (ArrayUtils.isNotEmpty(methodProduces)) {`
`241`	`241`	`return content;`
`242`	`242`	`}`
`243`	`243`
`244`		`- private Type getReturnType(Method method) {`
	`244`	`+ private Type getReturnType(Method method,Class<?> clazz) {`
`245`	`245`	`Type returnType = Object.class;`
`246`	`246`	`for (ReturnTypeParser returnTypeParser : returnTypeParsers) {`
`247`	`247`	`if (returnType.getTypeName().equals(Object.class.getTypeName())) {`
`248`		`- returnType = returnTypeParser.getReturnType(method);`
	`248`	`+ returnType = returnTypeParser.getReturnType(method,clazz);`
`249`	`249`	`}`
`250`	`250`	`else {`
`251`	`251`	`break;`
`@@ -272,12 +272,12 @@ private void setContent(String[] methodProduces, Content content,`
`272`	`272`	`Arrays.stream(methodProduces).forEach(mediaTypeStr -> content.addMediaType(mediaTypeStr, mediaType));`
`273`	`273`	`}`
`274`	`274`
`275`		`- private void buildApiResponses(Components components, Method method, ApiResponses apiResponsesOp,`
	`275`	`+ private void buildApiResponses(Components components, Method method, Class<?> clazz, ApiResponses apiResponsesOp,`
`276`	`276`	`MethodAttributes methodAttributes, String httpCode, ApiResponse apiResponse, boolean isGeneric) {`
`277`	`277`	`// No documentation`
`278`	`278`	`if (StringUtils.isBlank(apiResponse.get$ref())) {`
`279`	`279`	`if (apiResponse.getContent() == null) {`
`280`		`- Content content = buildContent(components, method, methodAttributes.getMethodProduces(),`
	`280`	`+ Content content = buildContent(components, method,clazz, methodAttributes.getMethodProduces(),`
`281`	`281`	`methodAttributes.getJsonViewAnnotation());`
`282`	`282`	`apiResponse.setContent(content);`
`283`	`283`	`}`