Changes report: OpenAPIService is using ObjectMapper without configured modules since SpringDoc 1.6.7 springdoc#1655

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/providers/ObjectMapperProvider.java

@@ -27,6 +27,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.swagger.v3.core.util.Json;
 import io.swagger.v3.core.util.Json31;
+import io.swagger.v3.core.util.ObjectMapperFactory;
 import io.swagger.v3.core.util.Yaml;
 import io.swagger.v3.core.util.Yaml31;
 import org.springdoc.core.properties.SpringDocConfigProperties;
@@ -35,7 +36,7 @@
 /**
  * The type Spring doc object mapper provider.
  */
-public class ObjectMapperProvider {
+public class ObjectMapperProvider extends ObjectMapperFactory {
 
 	/**
 	 * The Json mapper.
@@ -81,4 +82,19 @@ public ObjectMapper jsonMapper() {
 	public ObjectMapper yamlMapper() {
 		return yamlMapper;
 	}
+
+	/**
+	 * Create json object mapper.
+	 *
+	 * @param springDocConfigProperties the spring doc config properties
+	 * @return the object mapper
+	 */
+	public static ObjectMapper createJson(SpringDocConfigProperties springDocConfigProperties) {
+		OpenApiVersion openApiVersion = springDocConfigProperties.getApiDocs().getVersion();
+		if (openApiVersion == OpenApiVersion.OPENAPI_3_1)
+			return ObjectMapperProvider.createJson31();
+		else
+			return ObjectMapperProvider.createJson();
+	}
+
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/service/OpenAPIService.java

@@ -69,6 +69,7 @@
 import org.springdoc.core.customizers.ServerBaseUrlCustomizer;
 import org.springdoc.core.properties.SpringDocConfigProperties;
 import org.springdoc.core.providers.JavadocProvider;
+import org.springdoc.core.providers.ObjectMapperProvider;
 import org.springdoc.core.utils.PropertyResolverUtils;
 
 import org.springframework.beans.BeansException;
@@ -258,7 +259,7 @@ public OpenAPI build(Locale locale) {
 		}
 		else {
 			try {
-				ObjectMapper objectMapper = new ObjectMapper();
+				ObjectMapper objectMapper = ObjectMapperProvider.createJson(springDocConfigProperties);
 				calculatedOpenAPI = objectMapper.readValue(objectMapper.writeValueAsString(openAPI), OpenAPI.class);
 			}
 			catch (JsonProcessingException e) {

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app188/HelloController.java

@@ -0,0 +1,97 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  *
+ *  *  *  *  * 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.app188;
+
+
+import java.time.Instant;
+import java.util.Map;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.Operation;
+import io.swagger.v3.oas.models.media.Content;
+import io.swagger.v3.oas.models.responses.ApiResponse;
+import org.springdoc.core.customizers.OperationCustomizer;
+import org.springdoc.core.utils.SpringDocAnnotationsUtils;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.method.HandlerMethod;
+
+@RestController
+public class HelloController {
+
+	@GetMapping("/test")
+	public void test(){}
+
+	@Bean
+	public OpenAPI openAPI(){return new OpenAPI().components(new Components());}
+
+	@Bean
+	public OperationCustomizer operationCustomizer(OpenAPI api){
+		io.swagger.v3.oas.models.media.Schema errorResponseSchema= SpringDocAnnotationsUtils.extractSchema(
+				api.getComponents(),
+				ErrorResponse.class,
+				null,
+				null
+		);
+
+		ApiResponse errorApiResponse=new ApiResponse().content(new Content().addMediaType(
+				MediaType.APPLICATION_JSON_VALUE,
+				new io.swagger.v3.oas.models.media.MediaType().schema(errorResponseSchema)
+		));
+
+		return(Operation operation, HandlerMethod handlerMethod)->{
+			operation.getResponses().addApiResponse("5xx",errorApiResponse);
+			return operation;
+		};
+	}
+
+	public class ErrorResponse {
+		@Schema(example = "2022-05-09T00:00:00.000Z")
+		Instant timestamp;
+		@Schema(example = "{\"param1\":\"val1\",\"param2\":\"val2\"}")
+		Map<String, Object> data;
+
+		public Instant getTimestamp() {
+			return timestamp;
+		}
+
+		public void setTimestamp(Instant timestamp) {
+			this.timestamp = timestamp;
+		}
+
+		public Map<String, Object> getData() {
+			return data;
+		}
+
+		public void setData(Map<String, Object> data) {
+			this.data = data;
+		}
+	}
+}

springdoc-openapi-starter-webmvc-api/src/test/java/test/org/springdoc/api/v30/app188/SpringDocApp188Test.java

@@ -0,0 +1,36 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  *
+ *  *  *  *  * 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.app188;
+
+import test.org.springdoc.api.v30.AbstractSpringDocV30Test;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp188Test extends AbstractSpringDocV30Test {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-starter-webmvc-api/src/test/resources/results/3.0.1/app188.json

@@ -0,0 +1,65 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/test": {
+      "get": {
+        "tags": [
+          "hello-controller"
+        ],
+        "operationId": "test",
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "5xx": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "ErrorResponse": {
+        "type": "object",
+        "properties": {
+          "timestamp": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2022-05-09T00:00:00Z"
+          },
+          "data": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "example": {
+                "param1": "val1",
+                "param2": "val2"
+              }
+            },
+            "example": {
+              "param1": "val1",
+              "param2": "val2"
+            }
+          }
+        }
+      }
+    }
+  }
+}