GroupedApi orders by displayName instead of name. Fixes #2576

Author: bnasslahsen

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/properties/SwaggerUiConfigParameters.java

@@ -304,9 +304,9 @@ public Map<String, Object> getConfigParameters() {
 	private void put(String urls, Set<SwaggerUrl> swaggerUrls, Map<String, Object> params) {
 		Comparator<SwaggerUrl> swaggerUrlComparator;
 		if (groupsOrder.isAscending())
-			swaggerUrlComparator = Comparator.comparing(SwaggerUrl::getName);
+			swaggerUrlComparator = Comparator.comparing(SwaggerUrl::getDisplayName);
 		else
-			swaggerUrlComparator = (h1, h2) -> h2.getName().compareTo(h1.getName());
+			swaggerUrlComparator = (h1, h2) -> h2.getDisplayName().compareTo(h1.getDisplayName());
 
 		swaggerUrls = swaggerUrls.stream().sorted(swaggerUrlComparator).filter(elt -> StringUtils.isNotEmpty(elt.getUrl())).collect(Collectors.toCollection(LinkedHashSet::new));
 		if (!CollectionUtils.isEmpty(swaggerUrls)) {

springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app4/SpringDocApp4Test.java

@@ -37,10 +37,10 @@ public void swagger_config_for_multiple_groups() throws Exception {
 				.andExpect(status().isOk())
 				.andExpect(jsonPath("configUrl", equalTo("/v3/api-docs/swagger-config")))
 				.andExpect(jsonPath("url").doesNotExist())
-				.andExpect(jsonPath("urls[0].url", equalTo("/v3/api-docs/stores")))
-				.andExpect(jsonPath("urls[0].name", equalTo("stores")))
-				.andExpect(jsonPath("urls[1].url", equalTo("/v3/api-docs/pets")))
-				.andExpect(jsonPath("urls[1].name", equalTo("The pets")))
+				.andExpect(jsonPath("urls[1].url", equalTo("/v3/api-docs/stores")))
+				.andExpect(jsonPath("urls[1].name", equalTo("stores")))
+				.andExpect(jsonPath("urls[0].url", equalTo("/v3/api-docs/pets")))
+				.andExpect(jsonPath("urls[0].name", equalTo("zpets")))
 				.andExpect(jsonPath("$['urls.primaryName']", equalTo("pets")));
 	}
 }

springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app4/SpringDocTestApp.java

@@ -47,7 +47,7 @@ public GroupedOpenApi groupOpenApi() {
 		String[] paths = { "/pet/**" };
 		return GroupedOpenApi.builder()
 				.group("pets")
-				.displayName("The pets")
+				.displayName("zpets")
 				.pathsToMatch(paths)
 				.build();
 	}