Example demonstrating loss of type information with generics

Author: robfletcher

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app88/PetController.java

@@ -0,0 +1,64 @@
+package test.org.springdoc.api.app88;
+
+import java.util.UUID;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController("pet")
+public class PetController {
+
+  @PutMapping("/{petRecordId}")
+  @Operation
+  public ResponseEntity<PetController.PetRecord<?>> putPetRecord(
+    @PathVariable UUID petRecordId,
+    @RequestBody PetController.PetRecord<?> petRecord
+  ) {
+    return ResponseEntity.ok(petRecord);
+  }
+
+  static class PetRecord<T extends Pet> {
+    private final String owner;
+    private final T pet;
+
+    public PetRecord(String owner, T pet) {
+      this.owner = owner;
+      this.pet = pet;
+    }
+
+    public String getOwner() {
+      return owner;
+    }
+
+    public T getPet() {
+      return pet;
+    }
+  }
+
+  interface Pet {
+    String getName();
+  }
+
+  static class Cat implements Pet {
+    private final String name;
+
+    Cat(String name) {this.name = name;}
+
+    @Override public String getName() {
+      return name;
+    }
+  }
+
+  static class Dog implements Pet {
+    private final String name;
+
+    Dog(String name) {this.name = name;}
+
+    @Override public String getName() {
+      return name;
+    }
+  }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app88/PetModelConverter.java

@@ -0,0 +1,29 @@
+package test.org.springdoc.api.app88;
+
+import java.util.Iterator;
+import com.fasterxml.jackson.databind.type.SimpleType;
+import io.swagger.v3.core.converter.AnnotatedType;
+import io.swagger.v3.core.converter.ModelConverter;
+import io.swagger.v3.core.converter.ModelConverterContext;
+import io.swagger.v3.oas.models.media.ComposedSchema;
+import io.swagger.v3.oas.models.media.Schema;
+import org.springframework.stereotype.Component;
+
+@Component
+public class PetModelConverter implements ModelConverter {
+  @Override
+  public Schema<?> resolve(
+    AnnotatedType annotatedType,
+    ModelConverterContext modelConverterContext,
+    Iterator<ModelConverter> iterator) {
+    if (annotatedType.getType() instanceof SimpleType && ((SimpleType)annotatedType.getType()).getRawClass().equals(PetController.Pet.class)) {
+      modelConverterContext.defineModel("Cat", modelConverterContext.resolve(new AnnotatedType(PetController.Cat.class)));
+      modelConverterContext.defineModel("Dog", modelConverterContext.resolve(new AnnotatedType(PetController.Dog.class)));
+      return new ComposedSchema()
+        .addOneOfItem(new Schema<>().$ref("#/components/schemas/Cat"))
+        .addOneOfItem(new Schema<>().$ref("#/components/schemas/Dog"));
+    } else {
+      return iterator.next().resolve(annotatedType, modelConverterContext, iterator);
+    }
+  }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app88/SpringDocApp88Test.java

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

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

@@ -0,0 +1,93 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/{petRecordId}": {
+      "put": {
+        "tags": [
+          "pet-controller"
+        ],
+        "operationId": "putPetRecord",
+        "parameters": [
+          {
+            "name": "petRecordId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PetRecord"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "default response",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/PetRecord"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Cat": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "Dog": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        }
+      },
+      "PetRecord": {
+        "type": "object",
+        "properties": {
+          "owner": {
+            "type": "string"
+          },
+          "pet": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/Cat"
+              },
+              {
+                "$ref": "#/components/schemas/Dog"
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}