Objects properties order is not preserved with springdoc.api-docs.resolve-schema-properties = true. Fixes #1274.

Author: bnasslahsen

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

@@ -26,9 +26,11 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Map.Entry;
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.Consumer;
@@ -396,10 +398,11 @@ public Schema resolveProperties(Schema schema, PropertyResolverUtils propertyRes
 
 		Map<String, Schema> properties = schema.getProperties();
 		if (!CollectionUtils.isEmpty(properties)) {
-			Map<String, Schema> resolvedSchemas = properties.entrySet().stream().map(es -> {
+			LinkedHashMap<String, Schema> resolvedSchemas = properties.entrySet().stream().map(es -> {
 				es.setValue(resolveProperties(es.getValue(), propertyResolverUtils, locale));
 				return es;
-			}).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+			}).collect(Collectors.toMap(Entry::getKey, Entry::getValue, (e1, e2) -> e2,
+					LinkedHashMap::new));
 			schema.setProperties(resolvedSchemas);
 		}
 
@@ -544,7 +547,7 @@ private void resolveProperty(Supplier<String> getProperty, Consumer<String> setP
 	 *
 	 * @param components the components
 	 */
-	private void calculateSecuritySchemes(Components components,Locale locale) {
+	private void calculateSecuritySchemes(Components components, Locale locale) {
 		// Look for SecurityScheme in a spring managed bean
 		Map<String, Object> securitySchemeBeans = context
 				.getBeansWithAnnotation(io.swagger.v3.oas.annotations.security.SecurityScheme.class);

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

@@ -71,6 +71,7 @@
 import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.util.CollectionUtils;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
@@ -326,7 +327,8 @@ OpenApiCustomiser propertiesResolverForSchema(PropertyResolverUtils propertyReso
 		return openApi -> {
 			Components components = openApi.getComponents();
 			Map<String, Schema> schemas = components.getSchemas();
-			schemas.values().forEach(schema -> openAPIService.resolveProperties(schema, propertyResolverUtils, Locale.getDefault()));
+			if (!CollectionUtils.isEmpty(schemas))
+				schemas.values().forEach(schema -> openAPIService.resolveProperties(schema, propertyResolverUtils, Locale.getDefault()));
 		};
 	}
 

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app164/SampleResponseClass.java

@@ -0,0 +1,45 @@
+package test.org.springdoc.api.app164;
+
+public class SampleResponseClass {
+
+	private String idAsFirstParameter;
+
+	private String nameAsSecondParamater;
+
+	private String lastNameAsThirdParameter;
+
+	private boolean booleanValueAsFourthParameter;
+
+	public String getIdAsFirstParameter() {
+		return idAsFirstParameter;
+	}
+
+	public void setIdAsFirstParameter(String idAsFirstParameter) {
+		this.idAsFirstParameter = idAsFirstParameter;
+	}
+
+	public String getNameAsSecondParamater() {
+		return nameAsSecondParamater;
+	}
+
+	public void setNameAsSecondParamater(String nameAsSecondParamater) {
+		this.nameAsSecondParamater = nameAsSecondParamater;
+	}
+
+	public String getLastNameAsThirdParameter() {
+		return lastNameAsThirdParameter;
+	}
+
+	public void setLastNameAsThirdParameter(String lastNameAsThirdParameter) {
+		this.lastNameAsThirdParameter = lastNameAsThirdParameter;
+	}
+
+	public boolean isBooleanValueAsFourthParameter() {
+		return booleanValueAsFourthParameter;
+	}
+
+	public void setBooleanValueAsFourthParameter(boolean aBooleanValueAsFourthParameter) {
+		this.booleanValueAsFourthParameter = aBooleanValueAsFourthParameter;
+	}
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app164/SpringDocApp164Test.java

@@ -0,0 +1,33 @@
+/*
+ *
+ *  * Copyright 2019-2021 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.app164;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+
+@TestPropertySource(properties = "springdoc.api-docs.resolve-schema-properties=true")
+public class SpringDocApp164Test extends AbstractSpringDocTest {
+
+  @SpringBootApplication
+  static class SpringDocTestApp {
+  }
+
+}

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app164/TestApiController.java

@@ -0,0 +1,14 @@
+package test.org.springdoc.api.app164;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class TestApiController {
+
+	@GetMapping(value = "/test")
+	public SampleResponseClass getInvoices() {
+		return null;
+	}
+
+}

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

@@ -0,0 +1,56 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "title": "OpenAPI definition",
+    "version": "v0"
+  },
+  "servers": [
+    {
+      "url": "http://localhost",
+      "description": "Generated server url"
+    }
+  ],
+  "paths": {
+    "/test": {
+      "get": {
+        "tags": [
+          "test-api-controller"
+        ],
+        "operationId": "getInvoices",
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "*/*": {
+                "schema": {
+                  "$ref": "#/components/schemas/SampleResponseClass"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "SampleResponseClass": {
+        "type": "object",
+        "properties": {
+          "idAsFirstParameter": {
+            "type": "string"
+          },
+          "nameAsSecondParamater": {
+            "type": "string"
+          },
+          "lastNameAsThirdParameter": {
+            "type": "string"
+          },
+          "booleanValueAsFourthParameter": {
+            "type": "boolean"
+          }
+        }
+      }
+    }
+  }
+}