Changes report: Please add OpenAPI 3.1 supports #1181

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/api/AbstractOpenApiResource.java

@@ -2,19 +2,21 @@
  *
  *  *
  *  *  *
- *  *  *  * 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
+ *  *  *  *  * 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.
  *  *  *  *
- *  *  *  *      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.
  *  *  *
  *  *
  *
@@ -54,9 +56,7 @@
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature;
 import io.swagger.v3.core.filter.SpecFilter;
-import io.swagger.v3.core.util.Json;
 import io.swagger.v3.core.util.ReflectionUtils;
-import io.swagger.v3.core.util.Yaml;
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.callbacks.Callback;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
@@ -84,9 +84,12 @@
 import org.springdoc.core.fn.RouterFunctionData;
 import org.springdoc.core.fn.RouterOperation;
 import org.springdoc.core.mixins.SortedOpenAPIMixin;
+import org.springdoc.core.mixins.SortedOpenAPIMixin31;
 import org.springdoc.core.mixins.SortedSchemaMixin;
+import org.springdoc.core.mixins.SortedSchemaMixin31;
 import org.springdoc.core.models.MethodAttributes;
 import org.springdoc.core.properties.SpringDocConfigProperties;
+import org.springdoc.core.properties.SpringDocConfigProperties.ApiDocs.OpenApiVersion;
 import org.springdoc.core.properties.SpringDocConfigProperties.GroupConfig;
 import org.springdoc.core.providers.ActuatorProvider;
 import org.springdoc.core.providers.CloudFunctionProvider;
@@ -317,6 +320,8 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 			Map<String, Object> findControllerAdvice = openAPIService.getControllerAdviceMap();
 			// calculate generic responses
 			openApi = openAPIService.getCalculatedOpenAPI();
+			if (OpenApiVersion.OPENAPI_3_1 == springDocConfigProperties.getApiDocs().getVersion())
+				openApi.openapi(OpenApiVersion.OPENAPI_3_1.getVersion());
 			if (springDocConfigProperties.isDefaultOverrideWithGenericResponse()) {
 				if (!CollectionUtils.isEmpty(mappingsMap))
 					findControllerAdvice.putAll(mappingsMap);
@@ -343,8 +348,8 @@ protected synchronized OpenAPI getOpenApi(Locale locale) {
 			List<Server> servers = openApi.getServers();
 			List<Server> serversCopy = null;
 			try {
-				serversCopy = Json.mapper()
-						.readValue(Json.mapper().writeValueAsString(servers), new TypeReference<List<Server>>() {});
+				serversCopy = springDocProviders.jsonMapper()
+						.readValue(springDocProviders.jsonMapper().writeValueAsString(servers), new TypeReference<List<Server>>() {});
 			}
 			catch (JsonProcessingException e) {
 				LOGGER.warn("Json Processing Exception occurred: {}", e.getMessage());
@@ -1174,7 +1179,7 @@ protected void initOpenAPIBuilder(Locale locale) {
 	 */
 	protected String writeYamlValue(OpenAPI openAPI) throws JsonProcessingException {
 		String result;
-		ObjectMapper objectMapper = Yaml.mapper();
+		ObjectMapper objectMapper = springDocProviders.yamlMapper();
 		if (springDocConfigProperties.isWriterWithOrderByKeys())
 			sortOutput(objectMapper);
 		YAMLFactory factory = (YAMLFactory) objectMapper.getFactory();
@@ -1245,7 +1250,7 @@ protected boolean isActuatorRestController(String operationPath, HandlerMethod h
 	 */
 	protected String writeJsonValue(OpenAPI openAPI) throws JsonProcessingException {
 		String result;
-		ObjectMapper objectMapper = Json.mapper();
+		ObjectMapper objectMapper = springDocProviders.jsonMapper();
 		if (springDocConfigProperties.isWriterWithOrderByKeys())
 			sortOutput(objectMapper);
 		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
@@ -1324,8 +1329,13 @@ enum ConditionType {
 	private void sortOutput(ObjectMapper objectMapper) {
 		objectMapper.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true);
 		objectMapper.configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY, true);
-		objectMapper.addMixIn(OpenAPI.class, SortedOpenAPIMixin.class);
-		objectMapper.addMixIn(Schema.class, SortedSchemaMixin.class);
+		if (OpenApiVersion.OPENAPI_3_1 == springDocConfigProperties.getApiDocs().getVersion()){
+			objectMapper.addMixIn(OpenAPI.class, SortedOpenAPIMixin31.class);
+			objectMapper.addMixIn(Schema.class, SortedSchemaMixin31.class);
+		} else {
+			objectMapper.addMixIn(OpenAPI.class, SortedOpenAPIMixin.class);
+			objectMapper.addMixIn(Schema.class, SortedSchemaMixin.class);
+		}
 	}
 
 	/**

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocConfiguration.java

@@ -2,19 +2,21 @@
  *
  *  *
  *  *  *
- *  *  *  * 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
+ *  *  *  *  * 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.
  *  *  *  *
- *  *  *  *      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.
  *  *  *
  *  *
  *
@@ -65,6 +67,7 @@
 import org.springdoc.core.providers.ActuatorProvider;
 import org.springdoc.core.providers.CloudFunctionProvider;
 import org.springdoc.core.providers.JavadocProvider;
+import org.springdoc.core.providers.ObjectMapperProvider;
 import org.springdoc.core.providers.RepositoryRestConfigurationProvider;
 import org.springdoc.core.providers.RepositoryRestResourceProvider;
 import org.springdoc.core.providers.RouterFunctionProvider;
@@ -150,12 +153,13 @@ LocalVariableTableParameterNameDiscoverer localSpringDocParameterNameDiscoverer(
 	/**
 	 * Additional models converter additional models converter.
 	 *
+	 * @param objectMapperProvider the object mapper provider
 	 * @return the additional models converter
 	 */
 	@Bean
 	@Lazy(false)
-	AdditionalModelsConverter additionalModelsConverter() {
-		return new AdditionalModelsConverter();
+	AdditionalModelsConverter additionalModelsConverter(ObjectMapperProvider objectMapperProvider) {
+		return new AdditionalModelsConverter(objectMapperProvider);
 	}
 
 	/**
@@ -173,25 +177,27 @@ PropertyCustomizingConverter propertyCustomizingConverter(Optional<List<Property
 	/**
 	 * File support converter file support converter.
 	 *
+	 * @param objectMapperProvider the object mapper provider
 	 * @return the file support converter
 	 */
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	FileSupportConverter fileSupportConverter() {
-		return new FileSupportConverter();
+	FileSupportConverter fileSupportConverter(ObjectMapperProvider objectMapperProvider) {
+		return new FileSupportConverter(objectMapperProvider);
 	}
 
 	/**
 	 * Response support converter response support converter.
 	 *
+	 * @param objectMapperProvider the object mapper provider
 	 * @return the response support converter
 	 */
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
-	ResponseSupportConverter responseSupportConverter() {
-		return new ResponseSupportConverter();
+	ResponseSupportConverter responseSupportConverter(ObjectMapperProvider objectMapperProvider) {
+		return new ResponseSupportConverter(objectMapperProvider);
 	}
 
 	/**
@@ -210,14 +216,15 @@ SchemaPropertyDeprecatingConverter schemaPropertyDeprecatingConverter() {
 	/**
 	 * Polymorphic model converter polymorphic model converter.
 	 *
+	 * @param objectMapperProvider the object mapper provider
 	 * @return the polymorphic model converter
 	 */
 	@Bean
 	@ConditionalOnMissingBean
 	@ConditionalOnProperty(name = SPRINGDOC_POLYMORPHIC_CONVERTER_ENABLED, matchIfMissing = true)
 	@Lazy(false)
-	PolymorphicModelConverter polymorphicModelConverter() {
-		return new PolymorphicModelConverter();
+	PolymorphicModelConverter polymorphicModelConverter(ObjectMapperProvider objectMapperProvider) {
+		return new PolymorphicModelConverter(objectMapperProvider);
 	}
 
 	/**
@@ -227,8 +234,8 @@ PolymorphicModelConverter polymorphicModelConverter() {
 	 * @param securityParser the security parser
 	 * @param springDocConfigProperties the spring doc config properties
 	 * @param propertyResolverUtils the property resolver utils
-	 * @param openApiBuilderCustomizers the open api builder customisers
-	 * @param serverBaseUrlCustomizers the server base url customizers
+	 * @param openApiBuilderCustomisers the open api builder customisers
+	 * @param serverBaseUrlCustomisers the server base url customisers
 	 * @param javadocProvider the javadoc provider
 	 * @return the open api builder
 	 */
@@ -237,11 +244,10 @@ PolymorphicModelConverter polymorphicModelConverter() {
 	@Lazy(false)
 	OpenAPIService openAPIBuilder(Optional<OpenAPI> openAPI,
 			SecurityService securityParser,
-			SpringDocConfigProperties springDocConfigProperties, PropertyResolverUtils propertyResolverUtils,
-			Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomizers,
-			Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomizers,
-			Optional<JavadocProvider> javadocProvider) {
-		return new OpenAPIService(openAPI, securityParser, springDocConfigProperties, propertyResolverUtils, openApiBuilderCustomizers, serverBaseUrlCustomizers, javadocProvider);
+			SpringDocConfigProperties springDocConfigProperties,PropertyResolverUtils propertyResolverUtils,
+			Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers,
+			Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomisers, Optional<JavadocProvider> javadocProvider) {
+		return new OpenAPIService(openAPI, securityParser, springDocConfigProperties, propertyResolverUtils, openApiBuilderCustomisers, serverBaseUrlCustomisers, javadocProvider);
 	}
 
 	/**
@@ -332,16 +338,17 @@ ReturnTypeParser genericReturnTypeParser() {
 	 * @param propertyResolverUtils the property resolver utils
 	 * @param optionalDelegatingMethodParameterCustomizer the optional delegating method parameter customizer
 	 * @param optionalWebConversionServiceProvider the optional web conversion service provider
+	 * @param objectMapperProvider the object mapper provider
 	 * @return the generic parameter builder
 	 */
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
 	GenericParameterService parameterBuilder(PropertyResolverUtils propertyResolverUtils,
 			Optional<DelegatingMethodParameterCustomizer> optionalDelegatingMethodParameterCustomizer,
-			Optional<WebConversionServiceProvider> optionalWebConversionServiceProvider) {
+			Optional<WebConversionServiceProvider> optionalWebConversionServiceProvider, ObjectMapperProvider objectMapperProvider) {
 		return new GenericParameterService(propertyResolverUtils, optionalDelegatingMethodParameterCustomizer,
-				optionalWebConversionServiceProvider);
+				optionalWebConversionServiceProvider, objectMapperProvider);
 	}
 
 	/**
@@ -399,14 +406,18 @@ static BeanFactoryPostProcessor springdocBeanFactoryPostProcessor2() {
 	 * @param repositoryRestResourceProvider the repository rest resource provider
 	 * @param routerFunctionProvider the router function provider
 	 * @param springWebProvider the spring web provider
+	 * @param webConversionServiceProvider the web conversion service provider
+	 * @param objectMapperProvider the object mapper provider
 	 * @return the spring doc providers
 	 */
 	@Bean
 	@ConditionalOnMissingBean
 	@Lazy(false)
 	SpringDocProviders springDocProviders(Optional<ActuatorProvider> actuatorProvider, Optional<CloudFunctionProvider> springCloudFunctionProvider, Optional<SecurityOAuth2Provider> springSecurityOAuth2Provider,
-			Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider, Optional<RouterFunctionProvider> routerFunctionProvider, Optional<SpringWebProvider> springWebProvider) {
-		return new SpringDocProviders(actuatorProvider, springCloudFunctionProvider, springSecurityOAuth2Provider, repositoryRestResourceProvider, routerFunctionProvider, springWebProvider);
+			Optional<RepositoryRestResourceProvider> repositoryRestResourceProvider, Optional<RouterFunctionProvider> routerFunctionProvider,
+			Optional<SpringWebProvider> springWebProvider,  Optional<WebConversionServiceProvider> webConversionServiceProvider,
+			ObjectMapperProvider objectMapperProvider) {
+		return new SpringDocProviders(actuatorProvider, springCloudFunctionProvider, springSecurityOAuth2Provider, repositoryRestResourceProvider, routerFunctionProvider, springWebProvider, webConversionServiceProvider, objectMapperProvider);
 	}
 
 	/**
@@ -535,4 +546,17 @@ RepositoryRestConfigurationProvider repositoryRestConfigurationProvider(Optional
 			return new RepositoryRestConfigurationProvider(optionalRepositoryRestConfiguration);
 		}
 	}
+
+	/**
+	 * Object mapper provider object mapper provider.
+	 *
+	 * @param springDocConfigProperties the spring doc config properties
+	 * @return the object mapper provider
+	 */
+	@Bean
+	@ConditionalOnMissingBean
+	@Lazy(false)
+	ObjectMapperProvider objectMapperProvider(SpringDocConfigProperties springDocConfigProperties){
+		return new ObjectMapperProvider(springDocConfigProperties);
+	}
 }

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/configuration/SpringDocDataRestConfiguration.java

@@ -2,19 +2,21 @@
  *
  *  *
  *  *  *
- *  *  *  * 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
+ *  *  *  *  * 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.
  *  *  *  *
- *  *  *  *      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.
  *  *  *
  *  *
  *
@@ -35,6 +37,7 @@
 import org.springdoc.core.data.DataRestTagsService;
 import org.springdoc.core.properties.SpringDocConfigProperties;
 import org.springdoc.core.providers.DataRestHalProvider;
+import org.springdoc.core.providers.ObjectMapperProvider;
 import org.springdoc.core.providers.SpringRepositoryRestResourceProvider;
 import org.springdoc.core.service.AbstractRequestService;
 import org.springdoc.core.service.GenericParameterService;
@@ -93,8 +96,8 @@ public class SpringDocDataRestConfiguration {
 	@ConditionalOnMissingBean
 	@Primary
 	@Lazy(false)
-	DataRestHalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConfiguration, Optional<HateoasProperties> hateoasPropertiesOptional) {
-		return new DataRestHalProvider(repositoryRestConfiguration, hateoasPropertiesOptional);
+	DataRestHalProvider halProvider(Optional<RepositoryRestConfiguration> repositoryRestConfiguration, Optional<HateoasProperties> hateoasPropertiesOptional, ObjectMapperProvider objectMapperProvider) {
+		return new DataRestHalProvider(repositoryRestConfiguration, hateoasPropertiesOptional, objectMapperProvider);
 	}