Added swagger-core 2.1.6 deterministic order support

Author: bnasslahsen

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

@@ -44,6 +44,7 @@
 
 import com.fasterxml.jackson.annotation.JsonView;
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.MapperFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
@@ -61,13 +62,16 @@
 import io.swagger.v3.oas.models.PathItem;
 import io.swagger.v3.oas.models.PathItem.HttpMethod;
 import io.swagger.v3.oas.models.Paths;
+import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.media.StringSchema;
 import io.swagger.v3.oas.models.parameters.Parameter;
 import io.swagger.v3.oas.models.responses.ApiResponses;
 import org.apache.commons.lang3.ArrayUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springdoc.api.mixins.SortedOpenAPIMixin;
+import org.springdoc.api.mixins.SortedSchemaMixin;
 import org.springdoc.core.AbstractRequestService;
 import org.springdoc.core.ActuatorProvider;
 import org.springdoc.core.GenericParameterService;
@@ -1025,7 +1029,7 @@ protected String writeYamlValue(OpenAPI openAPI) throws JsonProcessingException
 		String result;
 		ObjectMapper objectMapper = Yaml.mapper();
 		if (springDocConfigProperties.isWriterWithOrderByKeys())
-			objectMapper.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true);
+			sortOutput(objectMapper);
 		YAMLFactory factory = (YAMLFactory) objectMapper.getFactory();
 		factory.configure(Feature.USE_NATIVE_TYPE_ID, false);
 		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
@@ -1090,7 +1094,7 @@ protected String writeJsonValue(OpenAPI openAPI) throws JsonProcessingException
 		String result;
 		ObjectMapper objectMapper = Json.mapper();
 		if (springDocConfigProperties.isWriterWithOrderByKeys())
-			objectMapper.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, true);
+			sortOutput(objectMapper);
 		if (!springDocConfigProperties.isWriterWithDefaultPrettyPrinter())
 			result = objectMapper.writeValueAsString(openAPI);
 		else
@@ -1158,4 +1162,11 @@ enum ConditionType {
 		 */
 		HEADERS
 	}
+
+	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);
+	}
 }

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

@@ -0,0 +1,47 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 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 org.springdoc.api.mixins;
+
+import java.util.Map;
+
+import com.fasterxml.jackson.annotation.JsonAnyGetter;
+import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import io.swagger.v3.core.jackson.PathsSerializer;
+import io.swagger.v3.oas.models.Paths;
+
+/**
+ * @author bnasslashen
+ */
+@JsonPropertyOrder(value = {"openapi", "info", "externalDocs", "servers", "security", "tags", "paths", "components"}, alphabetic = true)
+public abstract class SortedOpenAPIMixin {
+
+	@JsonAnyGetter
+	@JsonPropertyOrder(alphabetic = true)
+	public abstract Map<String, Object> getExtensions();
+
+	@JsonAnySetter
+	public abstract void addExtension(String name, Object value);
+
+	@JsonSerialize(using = PathsSerializer.class)
+	public abstract Paths getPaths();
+}

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

@@ -0,0 +1,50 @@
+/*
+ *
+ *  *
+ *  *  * Copyright 2019-2020 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 org.springdoc.api.mixins;
+
+import java.util.Map;
+
+import com.fasterxml.jackson.annotation.JsonAnyGetter;
+import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+
+/**
+ * @author bnasslashen
+ */
+@JsonPropertyOrder(value = {"type", "format"}, alphabetic = true)
+public abstract class SortedSchemaMixin {
+
+	@JsonAnyGetter
+	@JsonPropertyOrder(alphabetic = true)
+	public abstract Map<String, Object> getExtensions();
+
+	@JsonAnySetter
+	public abstract void addExtension(String name, Object value);
+
+	@JsonIgnore
+	public abstract boolean getExampleSetFlag();
+
+	@JsonInclude(JsonInclude.Include.CUSTOM)
+	public abstract Object getExample();
+
+}