Review configuration via springdoc.swagger-ui.urls. Fixes #481

Author: bnasslahsen

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

@@ -48,7 +48,6 @@ private GroupedOpenApi(Builder builder) {
 		this.packagesToExclude=builder.packagesToExclude;
 		this.pathsToExclude=builder.pathsToExclude;
 		this.openApiCustomisers = Objects.requireNonNull(builder.openApiCustomisers);
-		SwaggerUiConfigProperties.addGroup(this.group);
 		if (CollectionUtils.isEmpty(this.pathsToMatch)
 				&& CollectionUtils.isEmpty(this.packagesToScan)
 				&& CollectionUtils.isEmpty(this.pathsToExclude)

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

@@ -54,7 +54,7 @@ public class SwaggerUiConfigProperties {
 
 	public static final String CONFIG_URL_PROPERTY = "configUrl";
 
-	private static Set<SwaggerUrl> swaggerUrls = new HashSet<>();
+	private Set<SwaggerUrl> urls = new HashSet<>();
 
 	/**
 	 * The path for the Swagger UI pages to load. Will redirect to the springdoc.webjars.prefix property.
@@ -158,26 +158,26 @@ public class SwaggerUiConfigProperties {
 
 	private Direction groupsOrder = Direction.ASC;
 
-	public static void addGroup(String group) {
+	public void addGroup(String group) {
 		SwaggerUrl swaggerUrl = new SwaggerUrl(group);
-		swaggerUrls.add(swaggerUrl);
+		urls.add(swaggerUrl);
 	}
 
-	public static void addGroup(String group, String url) {
-		SwaggerUrl swaggerUrl = new SwaggerUrl(group, url);
-		swaggerUrls.add(swaggerUrl);
+	public Set<SwaggerUrl> getUrls() {
+		return this.urls;
 	}
 
-	public static Set<SwaggerUrl> getSwaggerUrls() {
-		return swaggerUrls;
+	public void setUrls(Set<SwaggerUrl> urls) {
+		this.urls = urls;
 	}
 
-	public static void setSwaggerUrls(Set<SwaggerUrl> swaggerUrls) {
-		SwaggerUiConfigProperties.swaggerUrls = swaggerUrls;
-	}
-
-	public static void addUrl(String url) {
-		swaggerUrls.forEach(elt -> elt.setUrl(url + DEFAULT_PATH_SEPARATOR + elt.getName()));
+	public void addUrl(String url) {
+		this.urls.forEach(elt ->
+				{
+					if (StringUtils.isBlank(elt.url))
+						elt.setUrl(url + DEFAULT_PATH_SEPARATOR + elt.getName());
+				}
+		);
 	}
 
 	public Map<String, Object> getConfigParameters() {
@@ -203,7 +203,7 @@ public Map<String, Object> getConfigParameters() {
 			SpringDocPropertiesUtils.put("supportedSubmitMethods", supportedSubmitMethods.toString(), params);
 		SpringDocPropertiesUtils.put("oauth2RedirectUrl", oauth2RedirectUrl, params);
 		SpringDocPropertiesUtils.put("url", url, params);
-		put("urls", swaggerUrls, params);
+		put("urls", urls, params);
 		return params;
 	}
 
@@ -395,6 +395,8 @@ static class SwaggerUrl {
 
 		private String name;
 
+		public SwaggerUrl() { }
+
 		public SwaggerUrl(String group, String url) {
 			this.url = url;
 			this.name = group;
@@ -432,6 +434,15 @@ public boolean equals(Object o) {
 		public int hashCode() {
 			return Objects.hash(name);
 		}
+
+		@Override
+		public String toString() {
+			final StringBuilder sb = new StringBuilder("SwaggerUrl{");
+			sb.append("url='").append(url).append('\'');
+			sb.append(", name='").append(name).append('\'');
+			sb.append('}');
+			return sb.toString();
+		}
 	}
 
 	enum Direction {

springdoc-openapi-common/src/main/java/org/springdoc/ui/AbstractSwaggerWelcome.java

@@ -57,6 +57,7 @@ public AbstractSwaggerWelcome(SwaggerUiConfigProperties swaggerUiConfig, SpringD
 
 	@Override
 	public void afterPropertiesSet() {
+		springDocConfigProperties.getGroupConfigs().forEach( groupConfig -> swaggerUiConfig.addGroup(groupConfig.getGroup()));
 		calculateUiRootPath();
 	}
 
@@ -73,14 +74,14 @@ protected void buildConfigUrl(String contextPath, UriComponentsBuilder uriCompon
 			String url = buildUrl(contextPath, apiDocsUrl);
 			String swaggerConfigUrl = url + DEFAULT_PATH_SEPARATOR + SWAGGGER_CONFIG_FILE;
 			swaggerUiConfig.setConfigUrl(swaggerConfigUrl);
-			if (SwaggerUiConfigProperties.getSwaggerUrls().isEmpty()) {
+			if (swaggerUiConfig.getUrls().isEmpty()) {
 				if (StringUtils.isEmpty(swaggerUiUrl))
 					swaggerUiConfig.setUrl(url);
 				else
 					swaggerUiConfig.setUrl(swaggerUiUrl);
 			}
 			else
-				SwaggerUiConfigProperties.addUrl(url);
+				swaggerUiConfig.addUrl(url);
 		}
 		calculateOauth2RedirectUrl(uriComponentsBuilder);
 	}

springdoc-openapi-data-rest/src/test/resources/logback-test.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+	<root level="off"/>
+</configuration>

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

@@ -18,11 +18,7 @@
 
 package test.org.springdoc.ui.app4;
 
-import java.util.HashSet;
-
-import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Test;
-import org.springdoc.core.SwaggerUiConfigProperties;
 import test.org.springdoc.ui.AbstractSpringDocTest;
 
 import org.springframework.test.context.TestPropertySource;
@@ -46,9 +42,4 @@ public void swagger_config_for_multiple_groups() throws Exception {
 				.andExpect(jsonPath("urls[1].url", equalTo("/v3/api-docs/pets")))
 				.andExpect(jsonPath("urls[1].name", equalTo("pets")));
 	}
-
-	@AfterEach
-	public void reset() {
-		SwaggerUiConfigProperties.setSwaggerUrls(new HashSet<>());
-	}
 }

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app8/HelloController.java

@@ -0,0 +1,36 @@
+/*
+ *
+ *  * 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 test.org.springdoc.ui.app8;
+
+import javax.validation.Valid;
+import javax.validation.constraints.Size;
+
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+public class HelloController {
+
+	@GetMapping(value = "/persons")
+	public void persons(@Valid @RequestParam @Size(min = 4, max = 6) String name) {
+
+	}
+
+}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app8/SpringDocApp8Test.java

@@ -0,0 +1,54 @@
+/*
+ *
+ *  * 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 test.org.springdoc.ui.app8;
+
+import org.junit.jupiter.api.Test;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.test.context.TestPropertySource;
+import org.springframework.test.web.servlet.MvcResult;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@TestPropertySource(properties = {
+		"springdoc.swagger-ui.urls[0].name=users",
+		"springdoc.swagger-ui.urls[0].url=/api-docs.yaml"
+})
+public class SpringDocApp8Test extends AbstractSpringDocTest {
+
+	@Test
+	public void swagger_config_for_multiple_groups() throws Exception {
+		mockMvc.perform(get("/v3/api-docs/swagger-config"))
+				.andExpect(status().isOk())
+				.andExpect(jsonPath("configUrl", equalTo("/v3/api-docs/swagger-config")))
+				.andExpect(jsonPath("url").doesNotExist())
+				.andExpect(jsonPath("urls[0].url", equalTo("/api-docs.yaml")))
+				.andExpect(jsonPath("urls[0].name", equalTo("users")));
+	}
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}