Changes report: Add support for swagger-ui.url property #2189

Author: bnasslahsen

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

@@ -133,6 +133,16 @@ protected String overwriteSwaggerDefaultUrl(String html) {
 		return html.replace(Constants.SWAGGER_UI_DEFAULT_URL, StringUtils.EMPTY);
 	}
 
+	/**
+	 * Setting the url configured with swagger ui properties
+	 *
+	 * @param html
+	 * @return modifed html
+	 */
+	protected String setConfiguredApiDocsUrl(String html){
+		return html.replace(Constants.SWAGGER_UI_DEFAULT_URL, swaggerUiConfig.getUrl());
+	}
+	
 	/**
 	 * Default transformations string.
 	 *
@@ -165,6 +175,9 @@ else if (swaggerUiConfig.getCsrf().isUseSessionStorage())
 		if (swaggerUiConfig.isDisableSwaggerDefaultUrl())
 			html = overwriteSwaggerDefaultUrl(html);
 
+		if(StringUtils.isNotEmpty(swaggerUiConfig.getUrl())){
+			html = setConfiguredApiDocsUrl(html);
+		}
 		return html;
 	}
 

springdoc-openapi-common/src/test/java/org/springdoc/ui/AbstractSwaggerIndexTransformerTest.java

@@ -0,0 +1,68 @@
+package org.springdoc.ui;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springdoc.core.SwaggerUiConfigParameters;
+import org.springdoc.core.SwaggerUiConfigProperties;
+import org.springdoc.core.SwaggerUiOAuthProperties;
+import org.springdoc.core.providers.ObjectMapperProvider;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.containsString;
+
+@ExtendWith(MockitoExtension.class)
+public class AbstractSwaggerIndexTransformerTest {
+
+    private SwaggerUiConfigProperties swaggerUiConfig;
+    @Mock
+    private SwaggerUiOAuthProperties swaggerUiOAuthProperties;
+    @Mock
+    private SwaggerUiConfigParameters swaggerUiConfigParameters;
+    @Mock
+    private ObjectMapperProvider objectMapperProvider;
+
+    private AbstractSwaggerIndexTransformer underTest;
+
+    private final String swaggerInitJs = "window.onload = function() {\n" +
+            "\n" +
+            "  window.ui = SwaggerUIBundle({\n" +
+            "    url: \"https://petstore.swagger.io/v2/swagger.json\",\n" +
+            "    dom_id: '#swagger-ui',\n" +
+            "    deepLinking: true,\n" +
+            "    presets: [\n" +
+            "      SwaggerUIBundle.presets.apis,\n" +
+            "      SwaggerUIStandalonePreset\n" +
+            "    ],\n" +
+            "    plugins: [\n" +
+            "      SwaggerUIBundle.plugins.DownloadUrl\n" +
+            "    ],\n" +
+            "    layout: \"StandaloneLayout\"\n" +
+            "  });\n" +
+            "\n" +
+            "  //</editor-fold>\n" +
+            "};";
+    private final InputStream is = new ByteArrayInputStream(swaggerInitJs.getBytes());
+
+    private final String apiDocUrl = "http://test.springdoc.com/apidoc";
+
+    @BeforeEach
+    public void setup(){
+        swaggerUiConfig = new SwaggerUiConfigProperties();
+        swaggerUiConfig.setUrl(apiDocUrl);
+        underTest = new AbstractSwaggerIndexTransformer(swaggerUiConfig, swaggerUiOAuthProperties, swaggerUiConfigParameters, objectMapperProvider);
+
+    }
+
+    @Test
+    void setApiDocUrlCorrectly() throws IOException {
+		String html = underTest.defaultTransformations(is);
+        assertThat(html, containsString(apiDocUrl));
+    }
+}