Merge pull request #3096 from swagger-api/ticket-3082

 ref #3082 - updated returnType handling

Author: frantuma

modules/swagger-jaxrs2/src/main/java/io/swagger/v3/jaxrs2/Reader.java

@@ -413,6 +413,10 @@ public OpenAPI read(Class<?> cls,
                     continue;
                 } else if (StringUtils.isBlank(httpMethod) && subResource != null) {
                     Type returnType = method.getGenericReturnType();
+                    if (annotatedMethod != null && annotatedMethod.getType() != null) {
+                        returnType = annotatedMethod.getType();
+                    }
+
                     if (shouldIgnoreClass(returnType.getTypeName()) && !returnType.equals(subResource)) {
                         continue;
                     }
@@ -458,8 +462,8 @@ public OpenAPI read(Class<?> cls,
                         parentRequestBody,
                         parentResponses,
                         jsonViewAnnotation,
-                        classResponses
-                        );
+                        classResponses,
+                        annotatedMethod);
                 if (operation != null) {
 
                     List<Parameter> operationParameters = new ArrayList<>();
@@ -749,6 +753,7 @@ public Operation parseMethod(
                 null,
                 null,
                 jsonViewAnnotation,
+                null,
                 null);
     }
 
@@ -785,7 +790,46 @@ public Operation parseMethod(
                 parentRequestBody,
                 parentResponses,
                 jsonViewAnnotation,
-                classResponses);
+                classResponses,
+                null);
+    }
+
+    public Operation parseMethod(
+            Method method,
+            List<Parameter> globalParameters,
+            Produces methodProduces,
+            Produces classProduces,
+            Consumes methodConsumes,
+            Consumes classConsumes,
+            List<SecurityRequirement> classSecurityRequirements,
+            Optional<io.swagger.v3.oas.models.ExternalDocumentation> classExternalDocs,
+            Set<String> classTags,
+            List<io.swagger.v3.oas.models.servers.Server> classServers,
+            boolean isSubresource,
+            RequestBody parentRequestBody,
+            ApiResponses parentResponses,
+            JsonView jsonViewAnnotation,
+            io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses,
+            AnnotatedMethod annotatedMethod) {
+        JavaType classType = TypeFactory.defaultInstance().constructType(method.getDeclaringClass());
+        return parseMethod(
+                classType.getClass(),
+                method,
+                globalParameters,
+                methodProduces,
+                classProduces,
+                methodConsumes,
+                classConsumes,
+                classSecurityRequirements,
+                classExternalDocs,
+                classTags,
+                classServers,
+                isSubresource,
+                parentRequestBody,
+                parentResponses,
+                jsonViewAnnotation,
+                classResponses,
+                annotatedMethod);
     }
 
     private Operation parseMethod(
@@ -804,7 +848,8 @@ private Operation parseMethod(
             RequestBody parentRequestBody,
             ApiResponses parentResponses,
             JsonView jsonViewAnnotation,
-            io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses) {
+            io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses,
+            AnnotatedMethod annotatedMethod) {
         Operation operation = new Operation();
 
         io.swagger.v3.oas.annotations.Operation apiOperation = ReflectionUtils.getAnnotation(method, io.swagger.v3.oas.annotations.Operation.class);
@@ -962,6 +1007,11 @@ private Operation parseMethod(
 
         // handle return type, add as response in case.
         Type returnType = method.getGenericReturnType();
+
+        if (annotatedMethod != null && annotatedMethod.getType() != null) {
+            returnType = annotatedMethod.getType();
+        }
+
         final Class<?> subResource = getSubResourceWithJaxRsSubresourceLocatorSpecs(method);
         if (!shouldIgnoreClass(returnType.getTypeName()) && !returnType.equals(subResource)) {
             ResolvedSchema resolvedSchema = ModelConverters.getInstance().resolveAsResolvedSchema(new AnnotatedType(returnType).resolveAsRef(true).jsonViewAnnotation(jsonViewAnnotation));
@@ -1016,8 +1066,9 @@ private boolean shouldIgnoreClass(String className) {
             return true;
         }
         boolean ignore = false;
-        ignore = ignore || className.startsWith("javax.ws.rs.");
+        ignore = ignore || className.replace("[simple type, class ", "").startsWith("javax.ws.rs.");
         ignore = ignore || className.equalsIgnoreCase("void");
+        ignore = ignore || className.equalsIgnoreCase("[simple type, class void]");
         return ignore;
     }
 

modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/ReaderTest.java

@@ -61,6 +61,7 @@
 import io.swagger.v3.jaxrs2.resources.extensions.OperationExtensionsResource;
 import io.swagger.v3.jaxrs2.resources.extensions.ParameterExtensionsResource;
 import io.swagger.v3.jaxrs2.resources.extensions.RequestBodyExtensionsResource;
+import io.swagger.v3.jaxrs2.resources.rs.ProcessTokenRestService;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.ExternalDocumentation;
@@ -1970,4 +1971,36 @@ public void testTicket3029() {
                 "      example: 1\n";
         SerializationMatchers.assertEqualsToYaml(openAPI, yaml);
     }
+
+    @Test(description = "response generic subclass")
+    public void testTicket3082() {
+        Reader reader = new Reader(new OpenAPI());
+        OpenAPI openAPI = reader.read(ProcessTokenRestService.class);
+
+        String yaml = "openapi: 3.0.1\n" +
+                "paths:\n" +
+                "  /token:\n" +
+                "    post:\n" +
+                "      operationId: create\n" +
+                "      requestBody:\n" +
+                "        content:\n" +
+                "          application/json:\n" +
+                "            schema:\n" +
+                "              $ref: '#/components/schemas/ProcessTokenDTO'\n" +
+                "      responses:\n" +
+                "        default:\n" +
+                "          description: default response\n" +
+                "          content:\n" +
+                "            application/json:\n" +
+                "              schema:\n" +
+                "                $ref: '#/components/schemas/ProcessTokenDTO'\n" +
+                "components:\n" +
+                "  schemas:\n" +
+                "    ProcessTokenDTO:\n" +
+                "      type: object\n" +
+                "      properties:\n" +
+                "        guid:\n" +
+                "          type: string\n";
+        SerializationMatchers.assertEqualsToYaml(openAPI, yaml);
+    }
 }

modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/rs/AbstractEntityRestService.java

@@ -0,0 +1,10 @@
+package io.swagger.v3.jaxrs2.resources.rs;
+
+public abstract class AbstractEntityRestService<DTO extends PersistentDTO> implements EntityRestService<DTO> {
+
+    public DTO create(DTO object) throws Exception {
+        return null;
+    }
+
+}
+

modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/rs/EntityRestService.java

@@ -0,0 +1,13 @@
+package io.swagger.v3.jaxrs2.resources.rs;
+
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+
+public interface EntityRestService<DTO> {
+
+    @POST
+    @Path("/")
+    public DTO create(DTO object) throws Exception;
+
+
+}

modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/rs/PersistentDTO.java

@@ -0,0 +1,16 @@
+package io.swagger.v3.jaxrs2.resources.rs;
+
+public class PersistentDTO {
+
+    private String guid;
+
+    public void setGuid(String guid) {
+        this.guid = guid;
+    }
+
+    public String getGuid() {
+        return guid;
+    }
+
+
+}

modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/rs/ProcessTokenDTO.java

@@ -0,0 +1,7 @@
+package io.swagger.v3.jaxrs2.resources.rs;
+
+public class ProcessTokenDTO extends PersistentDTO {
+
+    private String name;
+
+}

modules/swagger-jaxrs2/src/test/java/io/swagger/v3/jaxrs2/resources/rs/ProcessTokenRestService.java

@@ -0,0 +1,14 @@
+package io.swagger.v3.jaxrs2.resources.rs;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+
+@Path("token")
+@Consumes(MediaType.APPLICATION_JSON)
+@Produces(MediaType.APPLICATION_JSON)
+public class ProcessTokenRestService extends AbstractEntityRestService<ProcessTokenDTO> {
+
+
+}