springdoc-openapi-starter-webmvc-ui 2.1.0. Fixes #2311

Author: bnasslahsen

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

@@ -97,6 +97,7 @@
 import org.springdoc.core.service.GenericResponseService;
 import org.springdoc.core.service.OpenAPIService;
 import org.springdoc.core.service.OperationService;
+import org.springdoc.core.utils.SpringDocUtils;
 
 import org.springframework.aop.support.AopUtils;
 import org.springframework.beans.factory.ObjectFactory;
@@ -1269,7 +1270,7 @@ protected URI getActuatorURI(String scheme, String host) {
 				port = actuatorProvider.getApplicationPort();
 				path = actuatorProvider.getContextPath();
 				String mvcServletPath = this.openAPIService.getContext().getBean(Environment.class).getProperty(SPRING_MVC_SERVLET_PATH);
-				if (StringUtils.isNotEmpty(mvcServletPath))
+				if (SpringDocUtils.isValidPath(mvcServletPath))
 					path = path + mvcServletPath;
 			}
 			try {

springdoc-openapi-starter-common/src/main/java/org/springdoc/core/utils/SpringDocUtils.java

@@ -28,6 +28,7 @@
 import java.util.function.Predicate;
 
 import io.swagger.v3.oas.models.media.Schema;
+import org.apache.commons.lang3.StringUtils;
 import org.springdoc.api.AbstractOpenApiResource;
 import org.springdoc.core.converters.AdditionalModelsConverter;
 import org.springdoc.core.converters.ConverterUtils;
@@ -375,5 +376,17 @@ public SpringDocUtils removeJavaTypeToIgnore(Class<?> clazz) {
 		ConverterUtils.removeJavaTypeToIgnore(clazz);
 		return this;
 	}
+
+	/**
+	 * Is valid path boolean.
+	 *
+	 * @param path the path
+	 * @return the boolean
+	 */
+	public static boolean isValidPath(String path) {
+		if (StringUtils.isNotBlank(path) && !path.equals("/"))
+			return true;
+		return false;
+	}
 }
 

springdoc-openapi-starter-webmvc-ui/src/main/java/org/springdoc/webmvc/ui/SwaggerUiHome.java

@@ -25,7 +25,7 @@
 package org.springdoc.webmvc.ui;
 
 import io.swagger.v3.oas.annotations.Operation;
-import org.apache.commons.lang3.StringUtils;
+import org.springdoc.core.utils.SpringDocUtils;
 
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Controller;
@@ -57,7 +57,7 @@ public class SwaggerUiHome {
 	@Operation(hidden = true)
 	public String index() {
 		StringBuilder uiRootPath = new StringBuilder();
-		if (StringUtils.isNotBlank(mvcServletPath))
+		if (SpringDocUtils.isValidPath(mvcServletPath))
 			uiRootPath.append(mvcServletPath);
 
 		return REDIRECT_URL_PREFIX + uiRootPath + swaggerUiPath;

springdoc-openapi-starter-webmvc-ui/src/main/java/org/springdoc/webmvc/ui/SwaggerWelcomeWebMvc.java

@@ -31,6 +31,7 @@
 import org.springdoc.core.properties.SwaggerUiConfigParameters;
 import org.springdoc.core.properties.SwaggerUiConfigProperties;
 import org.springdoc.core.providers.SpringWebProvider;
+import org.springdoc.core.utils.SpringDocUtils;
 
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.http.ResponseEntity;
@@ -99,7 +100,7 @@ public ResponseEntity<Void> redirectToUi(HttpServletRequest request) {
 	@Override
 	protected void calculateUiRootPath(StringBuilder... sbUrls) {
 		StringBuilder sbUrl = new StringBuilder();
-		if (StringUtils.isNotBlank(mvcServletPath))
+		if (SpringDocUtils.isValidPath(mvcServletPath))
 			sbUrl.append(mvcServletPath);
 		calculateUiRootCommon(sbUrl, sbUrls);
 	}
@@ -113,7 +114,7 @@ protected void calculateUiRootPath(StringBuilder... sbUrls) {
 	 */
 	@Override
 	protected String buildUrl(String contextPath, final String docsUrl) {
-		if (StringUtils.isNotBlank(mvcServletPath))
+		if (SpringDocUtils.isValidPath(mvcServletPath))
 			contextPath += mvcServletPath;
 		return super.buildUrl(contextPath, docsUrl);
 	}

springdoc-openapi-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app33/HelloController.java

@@ -0,0 +1,37 @@
+/*
+ *
+ *  * 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.app33;
+
+
+import jakarta.validation.Valid;
+import jakarta.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-starter-webmvc-ui/src/test/java/test/org/springdoc/ui/app33/SpringDocApp33Test.java

@@ -0,0 +1,49 @@
+/*
+ *
+ *  * 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.app33;
+
+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 static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@TestPropertySource(properties = {
+		"server.servlet.context-path=/",
+		"spring.mvc.servlet.path=/"
+})
+public class SpringDocApp33Test extends AbstractSpringDocTest {
+
+	@Test
+	public void shouldRedirectWithConfigUrlIgnoringQueryParams() throws Exception {
+		mockMvc.perform(get("/swagger-ui.html"))
+				.andExpect(status().isFound())
+				.andExpect(header().string("Location", "/swagger-ui/index.html"));
+
+		super.chekJS();
+	}
+
+	@SpringBootApplication
+	static class SpringDocTestApp {}
+
+}

springdoc-openapi-starter-webmvc-ui/src/test/resources/results/app33

@@ -0,0 +1,24 @@
+window.onload = function() {
+  //<editor-fold desc="Changeable Configuration Block">
+
+  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
+  window.ui = SwaggerUIBundle({
+    url: "https://petstore.swagger.io/v2/swagger.json",
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [
+      SwaggerUIBundle.presets.apis,
+      SwaggerUIStandalonePreset
+    ],
+    plugins: [
+      SwaggerUIBundle.plugins.DownloadUrl
+    ],
+    layout: "StandaloneLayout" ,
+
+  "configUrl" : "/v3/api-docs/swagger-config",
+  "validatorUrl" : ""
+
+  });
+
+  //</editor-fold>
+};