AdditionalModelsConverter Schema params rewriting. Fixes #1957

Author: bnasslahsen

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

@@ -26,11 +26,15 @@
 import java.util.Iterator;
 import java.util.Map;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.JavaType;
 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.Schema;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springdoc.core.providers.ObjectMapperProvider;
 
 /**
@@ -54,6 +58,11 @@ public class AdditionalModelsConverter implements ModelConverter {
 	 */
 	private static final Map<Class, Class> paramObjectReplacementMap = new HashMap<>();
 
+	/**
+	 * The constant LOGGER.
+	 */
+	private static final Logger LOGGER = LoggerFactory.getLogger(AdditionalModelsConverter.class);
+
 	/**
 	 * The Spring doc object mapper.
 	 */
@@ -130,8 +139,15 @@ public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterato
 		JavaType javaType = springDocObjectMapper.jsonMapper().constructType(type.getType());
 		if (javaType != null) {
 			Class<?> cls = javaType.getRawClass();
-			if (modelToSchemaMap.containsKey(cls))
-				return modelToSchemaMap.get(cls);
+			if (modelToSchemaMap.containsKey(cls)) {
+				try {
+					return springDocObjectMapper.jsonMapper()
+							.readValue(springDocObjectMapper.jsonMapper().writeValueAsString(modelToSchemaMap.get(cls)), new TypeReference<Schema>() {});
+				}
+				catch (JsonProcessingException e) {
+					LOGGER.warn("Json Processing Exception occurred: {}", e.getMessage());
+				}
+			}
 			if (modelToClassMap.containsKey(cls))
 				type = new AnnotatedType(modelToClassMap.get(cls)).resolveAsRef(true);
 		}

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

@@ -0,0 +1,15 @@
+package test.org.springdoc.api.v30.app198;
+
+import java.math.BigDecimal;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController("/")
+public class HelloController {
+
+	@GetMapping
+	public Response test() {
+		return new Response(BigDecimal.ONE, BigDecimal.ONE, BigDecimal.ONE);
+	}
+}

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

@@ -0,0 +1,49 @@
+package test.org.springdoc.api.v30.app198;
+
+import java.math.BigDecimal;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+/**
+ * @author bnasslahsen
+ */
+public class Response {
+
+	public Response(BigDecimal val1, BigDecimal val2, BigDecimal val3) {
+		this.val1 = val1;
+		this.val2 = val2;
+		this.val3 = val3;
+	}
+
+	@Schema(deprecated = true)
+	@Deprecated
+	private BigDecimal val1;
+
+	private BigDecimal val2;
+
+	private BigDecimal val3;
+
+	public BigDecimal getVal1() {
+		return val1;
+	}
+
+	public void setVal1(BigDecimal val1) {
+		this.val1 = val1;
+	}
+
+	public BigDecimal getVal2() {
+		return val2;
+	}
+
+	public void setVal2(BigDecimal val2) {
+		this.val2 = val2;
+	}
+
+	public BigDecimal getVal3() {
+		return val3;
+	}
+
+	public void setVal3(BigDecimal val3) {
+		this.val3 = val3;
+	}
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/v30/app198/SpringDocApp198Test.java

@@ -0,0 +1,45 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2022 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.v30.app198;
+
+import java.math.BigDecimal;
+
+import io.swagger.v3.oas.models.media.Schema;
+import org.springdoc.core.SpringDocUtils;
+import test.org.springdoc.api.v30.AbstractSpringDocV30Test;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp198Test extends AbstractSpringDocV30Test {
+
+	static {
+		SpringDocUtils.getConfig().replaceWithSchema(
+				BigDecimal.class,
+				new Schema<BigDecimal>().type("string").format("decimal")
+		);
+	}
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

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

@@ -0,0 +1,57 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "test",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/Response"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Response": {
+        "type": "object",
+        "properties": {
+          "val1": {
+            "type": "string",
+            "format": "decimal",
+            "deprecated": true
+          },
+          "val2": {
+            "type": "string",
+            "format": "decimal"
+          },
+          "val3": {
+            "type": "string",
+            "format": "decimal"
+          }
+        }
+      }
+    }
+  }
+}