Null vendor extensions are excluded from Json/Yaml. Fixes #1525

Author: bnasslahsen

springdoc-openapi-common/src/main/java/org/springdoc/api/mixins/SortedOpenAPIMixin.java

@@ -24,6 +24,8 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import io.swagger.v3.core.jackson.PathsSerializer;
@@ -36,6 +38,7 @@
 public interface SortedOpenAPIMixin {
 
 	@JsonAnyGetter
+	@JsonInclude(value = Include.ALWAYS)
 	@JsonPropertyOrder(alphabetic = true)
 	Map<String, Object> getExtensions();
 

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

@@ -39,9 +39,9 @@
 import java.util.stream.Stream;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import io.swagger.v3.core.jackson.TypeNameResolver;
 import io.swagger.v3.core.util.AnnotationsUtils;
-import io.swagger.v3.core.util.Json;
 import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
 import io.swagger.v3.oas.annotations.security.SecuritySchemes;
@@ -187,7 +187,7 @@ public class OpenAPIService implements ApplicationContextAware {
 	 * @param openApiBuilderCustomisers the open api builder customisers
 	 */
 	OpenAPIService(Optional<OpenAPI> openAPI, SecurityService securityParser,
-			SpringDocConfigProperties springDocConfigProperties,PropertyResolverUtils propertyResolverUtils,
+			SpringDocConfigProperties springDocConfigProperties, PropertyResolverUtils propertyResolverUtils,
 			Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers) {
 		if (openAPI.isPresent()) {
 			this.openAPI = openAPI.get();
@@ -198,7 +198,7 @@ public class OpenAPIService implements ApplicationContextAware {
 			if (!CollectionUtils.isEmpty(this.openAPI.getServers()))
 				this.isServersPresent = true;
 		}
-		this.propertyResolverUtils=propertyResolverUtils;
+		this.propertyResolverUtils = propertyResolverUtils;
 		this.securityParser = securityParser;
 		this.springDocConfigProperties = springDocConfigProperties;
 		this.openApiBuilderCustomisers = openApiBuilderCustomisers;
@@ -237,8 +237,8 @@ public void build(Locale locale) {
 		}
 		else {
 			try {
-				this.calculatedOpenAPI = Json.mapper()
-						.readValue(Json.mapper().writeValueAsString(openAPI), OpenAPI.class);
+				ObjectMapper objectMapper = new ObjectMapper();
+				this.calculatedOpenAPI = objectMapper.readValue(objectMapper.writeValueAsString(openAPI), OpenAPI.class );
 			}
 			catch (JsonProcessingException e) {
 				LOGGER.warn("Json Processing Exception occurred: {}", e.getMessage());
@@ -336,10 +336,9 @@ public Operation buildTags(HandlerMethod handlerMethod, Operation operation, Ope
 		}
 
 		if (!CollectionUtils.isEmpty(tagsStr)) {
-			if(CollectionUtils.isEmpty(operation.getTags()))
+			if (CollectionUtils.isEmpty(operation.getTags()))
 				operation.setTags(new ArrayList<>(tagsStr));
-			else
-			{
+			else {
 				Set<String> operationTagsSet = new HashSet<>(operation.getTags());
 				operationTagsSet.addAll(tagsStr);
 				operation.getTags().clear();

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app138/SpringDocApp138Test.java

@@ -22,12 +22,18 @@
  */
 package test.org.springdoc.api.app138;
 
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import io.swagger.v3.oas.models.OpenAPI;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.springdoc.core.Constants;
 import test.org.springdoc.api.AbstractSpringDocTest;
 
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
 import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.web.servlet.MvcResult;
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
@@ -44,8 +50,24 @@
 public class SpringDocApp138Test extends AbstractSpringDocTest {
 
 	@SpringBootApplication
-	static class SpringDocTestApp {}
+	static class SpringDocTestApp {
+		@Bean
+		public OpenAPI api() {
+			return new OpenAPI()
+					.extensions(apiExtensions());
+		}
+	}
+
+	private static Map<String, Object> apiExtensions() {
+		Map extensions = new HashMap<String, Object>();
 
+		Map linkedMap = new LinkedHashMap<String, String>();
+		linkedMap.put("property1", "value1");
+		linkedMap.put("property2", null);
+
+		extensions.put("x-my-vendor-extensions", linkedMap);
+		return extensions;
+	}
 	@Test
 	public void testApp() throws Exception {
 		MvcResult mockMvcResult = mockMvc.perform(MockMvcRequestBuilders.get(Constants.DEFAULT_API_DOCS_URL)).andExpect(status().isOk())

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

@@ -1 +1 @@
-{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"paths":{"/testA":{"get":{"tags":["hello-controller"],"operationId":"testA","parameters":[{"name":"hello","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}},"/testB":{"get":{"tags":["hello-controller"],"operationId":"testB","parameters":[{"name":"hello","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}}},"components":{}}
+{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"paths":{"/testA":{"get":{"operationId":"testA","parameters":[{"in":"query","name":"hello","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"tags":["hello-controller"]}},"/testB":{"get":{"operationId":"testB","parameters":[{"in":"query","name":"hello","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"tags":["hello-controller"]}}},"components":{},"x-my-vendor-extensions":{"property1":"value1","property2":null}}