Polymorphism - Support JsonTypeInfo.Id.CLASS. fixes #1799

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/core/converters/PolymorphicModelConverter.java

@@ -65,9 +65,7 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 		if (javaType != null) {
 			if (chain.hasNext()) {
 				Schema<?> resolvedSchema = chain.next().resolve(type, context, chain);
-				if (resolvedSchema instanceof  ObjectSchema && resolvedSchema.getProperties() != null
-						&& resolvedSchema.getProperties().containsKey(javaType.getRawClass().getSimpleName()))
-					resolvedSchema = resolvedSchema.getProperties().get(javaType.getRawClass().getSimpleName());
+				resolvedSchema = getResolvedSchema(javaType, resolvedSchema);
 				if (resolvedSchema == null || resolvedSchema.get$ref() == null)
 					return resolvedSchema;
 				return composePolymorphicSchema(type, resolvedSchema, context.getDefinedModels().values());
@@ -76,6 +74,16 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 		return null;
 	}
 
+	private static Schema<?> getResolvedSchema(JavaType javaType, Schema<?> resolvedSchema) {
+		if (resolvedSchema instanceof ObjectSchema && resolvedSchema.getProperties() != null){
+			if (resolvedSchema.getProperties().containsKey(javaType.getRawClass().getName()))
+				resolvedSchema = resolvedSchema.getProperties().get(javaType.getRawClass().getName());
+			else if (resolvedSchema.getProperties().containsKey(javaType.getRawClass().getSimpleName()))
+				resolvedSchema = resolvedSchema.getProperties().get(javaType.getRawClass().getSimpleName());
+		}
+		return resolvedSchema;
+	}
+
 	/**
 	 * Compose polymorphic schema schema.
 	 *

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app193/BasicController.java

@@ -12,9 +12,16 @@
 @RequestMapping(path = "/")
 public class BasicController {
 
-    @GetMapping("/test")
-    @Operation(summary = "get", description = "Provides an animal.")
-    public Animal get() {
+	@GetMapping("/test")
+	@ResponseStatus(HttpStatus.OK)
+	@Operation(summary = "get", description = "Provides a list of books.")
+	public Knowledge get() {
+		return new Books(new Book("Introduction to algorithms"));
+	}
+
+    @GetMapping("/test1")
+    @Operation(summary = "get1", description = "Provides an animal.")
+    public Animal get1() {
 
         return new Dog("Foo", 12);
     }

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app193/Book.java

@@ -0,0 +1,22 @@
+package test.org.springdoc.api.v30.app193;
+
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(description = "Represents a Book.")
+public class Book {
+
+    private String title;
+
+    public Book(String title) {
+        this.title = title;
+    }
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app193/Books.java

@@ -0,0 +1,23 @@
+package test.org.springdoc.api.v30.app193;
+
+
+import java.util.ArrayList;
+import java.util.Arrays;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+@Schema(description = "Represents a list of Books.")
+public class Books extends ArrayList<Book> implements Knowledge {
+
+    public Books() {
+        super();
+    }
+
+    public Books(Book... books) {
+        this();
+
+        if (books != null) {
+            Arrays.stream(books).forEach(this::add);
+        }
+    }
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app193/Knowledge.java

@@ -0,0 +1,14 @@
+package test.org.springdoc.api.v30.app193;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+/**
+ * Interface of the Knowledge.
+ */
+@Schema(description = "Represents the knowledge.")
+@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.WRAPPER_OBJECT)
+@JsonSubTypes({@JsonSubTypes.Type(value = Books.class)})
+public interface Knowledge {
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app193/Response.java

@@ -0,0 +1,18 @@
+package test.org.springdoc.api.v30.app193;
+
+public class Response {
+
+    private Knowledge books;
+
+    public Response(Knowledge books) {
+        this.books = books;
+    }
+
+    public Knowledge getBooks() {
+        return books;
+    }
+
+    public void setBooks(Knowledge books) {
+        this.books = books;
+    }
+}

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

@@ -17,8 +17,34 @@
           "basic-controller"
         ],
         "summary": "get",
-        "description": "Provides an animal.",
+        "description": "Provides a list of books.",
         "operationId": "get",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "oneOf": [
+                    {
+                      "$ref": "#/components/schemas/Books"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/test1": {
+      "get": {
+        "tags": [
+          "basic-controller"
+        ],
+        "summary": "get1",
+        "description": "Provides an animal.",
+        "operationId": "get1",
         "responses": {
           "200": {
             "description": "OK",
@@ -43,6 +69,27 @@
   },
   "components": {
     "schemas": {
+      "Books": {
+        "type": "array",
+        "description": "Represents a list of Books.",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/Knowledge"
+          },
+          {
+            "type": "object",
+            "properties": {
+              "empty": {
+                "type": "boolean"
+              }
+            }
+          }
+        ]
+      },
+      "Knowledge": {
+        "type": "object",
+        "description": "Represents the knowledge."
+      },
       "Animal": {
         "type": "object",
         "description": "Represents an Animal class."