Fix springdoc.swagger-ui.url. Fixes #339

Author: bnasslahsen

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

@@ -15,6 +15,8 @@ public final class Constants {
     public static final String SPRINGDOC_CACHE_DISABLED_VALUE= "${" + SPRINGDOC_CACHE_DISABLED + ":false}";
     public static final String SPRINGDOC_SWAGGER_UI_ENABLED = "springdoc.swagger-ui.enabled";
     public static final String SPRINGDOC_SWAGGER_UI_CONFIG_URL  ="springdoc.swagger-ui.configUrl";
+    public static final String SPRINGDOC_SWAGGER_UI_URL  ="springdoc.swagger-ui.url";
+    public static final String SPRINGDOC_SWAGGER_UI_URL_VALUE  ="${" + SPRINGDOC_SWAGGER_UI_URL + ":#{null}}";
     public static final String SPRINGDOC_SWAGGER_UI_CONFIG_URL_VALUE  ="${" + SPRINGDOC_SWAGGER_UI_CONFIG_URL + ":#{null}}";
     public static final String SPRINGDOC_SHOW_ACTUATOR = "springdoc.show-actuator";
     public static final String SPRINGDOC_SHOW_ACTUATOR_VALUE = "${" + SPRINGDOC_SHOW_ACTUATOR + ":false}";

springdoc-openapi-ui/src/main/java/org/springdoc/ui/SwaggerWelcome.java

@@ -40,6 +40,9 @@ class SwaggerWelcome implements InitializingBean {
     @Value(SPRINGDOC_SWAGGER_UI_CONFIG_URL_VALUE)
     private String originConfigUrl;
 
+    @Value(SPRINGDOC_SWAGGER_UI_URL_VALUE)
+    private String swaggerUiUrl;
+
     @Autowired
     private SwaggerUiConfigProperties swaggerUiConfig;
 
@@ -84,9 +87,12 @@ private void buildConfigUrl(HttpServletRequest request) {
             String url = buildUrl(request, apiDocsUrl);
             String swaggerConfigUrl = url + DEFAULT_PATH_SEPARATOR + SWAGGGER_CONFIG_FILE;
             swaggerUiConfig.setConfigUrl(swaggerConfigUrl);
-            if (SwaggerUiConfigProperties.getSwaggerUrls().isEmpty())
-                swaggerUiConfig.setUrl(url);
-            else
+            if (SwaggerUiConfigProperties.getSwaggerUrls().isEmpty()) {
+                if (StringUtils.isEmpty(swaggerUiUrl))
+                    swaggerUiConfig.setUrl(url);
+                else
+                    swaggerUiConfig.setUrl(swaggerUiUrl);
+            } else
                 SwaggerUiConfigProperties.addUrl(url);
         }
         if (!swaggerUiConfig.isValidUrl(swaggerUiConfig.getOauth2RedirectUrl())) {

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app6/SpringDocSwaggerUiUrlPropertyTest.java

@@ -0,0 +1,21 @@
+package test.org.springdoc.ui.app6;
+
+import org.junit.Test;
+import org.springframework.boot.test.context.SpringBootTest;
+import test.org.springdoc.ui.AbstractSpringDocTest;
+
+import static org.hamcrest.CoreMatchers.equalTo;
+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;
+
+@SpringBootTest(properties = "springdoc.swagger-ui.url=http://myserver:8080/v3/api-docs")
+public class SpringDocSwaggerUiUrlPropertyTest extends AbstractSpringDocTest {
+
+    @Test
+    public void with_swagger_ui_property() throws Exception {
+        mockMvc.perform(get("/v3/api-docs/swagger-config"))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("url", equalTo("http://myserver:8080/v3/api-docs")));
+    }
+}

springdoc-openapi-ui/src/test/java/test/org/springdoc/ui/app6/SpringDocTestApp.java

@@ -0,0 +1,33 @@
+package test.org.springdoc.ui.app6;
+
+import org.springdoc.core.GroupedOpenApi;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+
+@SpringBootApplication
+public class SpringDocTestApp {
+
+    public static void main(String[] args) {
+        SpringApplication.run(SpringDocTestApp.class, args);
+    }
+
+    @Bean
+    public GroupedOpenApi storeOpenApi() {
+        String paths[] = {"/store/**"};
+        return GroupedOpenApi.builder()
+                .setGroup("stores")
+                .pathsToMatch(paths)
+                .build();
+    }
+
+    @Bean
+    public GroupedOpenApi groupOpenApi() {
+        String paths[] = {"/pet/**"};
+        return GroupedOpenApi.builder()
+                .setGroup("pets")
+                .pathsToMatch(paths)
+                .build();
+    }
+
+}

springdoc-openapi-webflux-ui/src/main/java/org/springdoc/ui/SwaggerWelcome.java

@@ -36,6 +36,10 @@ public class SwaggerWelcome {
     private String uiPath;
     @Value(WEB_JARS_PREFIX_URL)
     private String webJarsPrefixUrl;
+    @Value(SPRINGDOC_SWAGGER_UI_URL_VALUE)
+    private String swaggerUiUrl;
+    @Value(SPRINGDOC_SWAGGER_UI_CONFIG_URL_VALUE)
+    private String originConfigUrl;
 
     @Bean
     @ConditionalOnProperty(name = SPRINGDOC_SWAGGER_UI_ENABLED, matchIfMissing = true)
@@ -56,15 +60,18 @@ RouterFunction<ServerResponse> getSwaggerUiConfig() {
     }
 
     private void buildConfigUrl() {
-        if (StringUtils.isEmpty(swaggerUiConfig.getConfigUrl())) {
+        if (StringUtils.isEmpty(originConfigUrl)){
             String swaggerConfigUrl = apiDocsUrl + DEFAULT_PATH_SEPARATOR + SWAGGGER_CONFIG_FILE;
             swaggerUiConfig.setConfigUrl(swaggerConfigUrl);
-
             if (SwaggerUiConfigProperties.getSwaggerUrls().isEmpty())
-                swaggerUiConfig.setUrl(apiDocsUrl);
+            {
+                if (StringUtils.isEmpty(swaggerUiUrl))
+                    swaggerUiConfig.setUrl(apiDocsUrl);
+                else
+                    swaggerUiConfig.setUrl(swaggerUiUrl);
+            }
             else
                 SwaggerUiConfigProperties.addUrl(apiDocsUrl);
-
         }
     }
 

springdoc-openapi-webmvc-core/src/test/java/test/org/springdoc/api/app73/HelloController.java

@@ -4,7 +4,6 @@
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.bind.annotation.*;
-import test.org.springdoc.api.app71.Dog;
 
 
 @RestController