Add method to retrieve server base URL and ability to 'customize' the generated server base URL

Author: skylar-stark

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

@@ -62,7 +62,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springdoc.core.customizers.OpenApiBuilderCustomizer;
-
+import org.springdoc.core.customizers.ServerBaseUrlCustomizer;
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.boot.autoconfigure.AutoConfigurationPackages;
@@ -120,6 +120,11 @@ public class OpenAPIService implements ApplicationContextAware {
 	 */
 	private final Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers;
 
+	/**
+	 * The server base URL customisers.
+	 */
+	private final Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomisers;
+
 	/**
 	 * The Spring doc config properties.
 	 */
@@ -188,7 +193,8 @@ public class OpenAPIService implements ApplicationContextAware {
 	 */
 	OpenAPIService(Optional<OpenAPI> openAPI, SecurityService securityParser,
 			SpringDocConfigProperties springDocConfigProperties, PropertyResolverUtils propertyResolverUtils,
-			Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers) {
+			Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers,
+			Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomisers) {
 		if (openAPI.isPresent()) {
 			this.openAPI = openAPI.get();
 			if (this.openAPI.getComponents() == null)
@@ -202,6 +208,7 @@ public class OpenAPIService implements ApplicationContextAware {
 		this.securityParser = securityParser;
 		this.springDocConfigProperties = springDocConfigProperties;
 		this.openApiBuilderCustomisers = openApiBuilderCustomisers;
+		this.serverBaseUrlCustomisers = serverBaseUrlCustomisers;
 		if (springDocConfigProperties.isUseFqn())
 			TypeNameResolver.std.setUseFqn(true);
 	}
@@ -466,7 +473,15 @@ public Schema resolveProperties(Schema schema, Locale locale) {
 	 * @param serverBaseUrl the server base url
 	 */
 	public void setServerBaseUrl(String serverBaseUrl) {
-		this.serverBaseUrl = serverBaseUrl;
+		String customServerBaseUrl = serverBaseUrl;
+
+		if (serverBaseUrlCustomisers.isPresent()) {
+			for (ServerBaseUrlCustomizer customiser : serverBaseUrlCustomisers.get()) {
+				customServerBaseUrl = customiser.customise(customServerBaseUrl);
+			}
+		}
+
+		this.serverBaseUrl = customServerBaseUrl;
 	}
 
 	/**
@@ -808,8 +823,17 @@ public SecurityService getSecurityParser() {
 		return securityParser;
 	}
 
+	/**
+	 * Gets server base URL
+	 * 
+	 * @return the server base URL
+	 */
+	public String getServerBaseUrl() {
+		return serverBaseUrl;
+	}
+
 	@Override
 	public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
 		this.context = applicationContext;
 	}
-}
+}

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

@@ -53,6 +53,7 @@
 import org.springdoc.core.customizers.OpenApiCustomiser;
 import org.springdoc.core.customizers.OperationCustomizer;
 import org.springdoc.core.customizers.PropertyCustomizer;
+import org.springdoc.core.customizers.ServerBaseUrlCustomizer;
 import org.springdoc.core.providers.ActuatorProvider;
 import org.springdoc.core.providers.CloudFunctionProvider;
 import org.springdoc.core.providers.JavadocProvider;
@@ -225,8 +226,9 @@ PolymorphicModelConverter polymorphicModelConverter() {
 	OpenAPIService openAPIBuilder(Optional<OpenAPI> openAPI,
 			SecurityService securityParser,
 			SpringDocConfigProperties springDocConfigProperties,PropertyResolverUtils propertyResolverUtils,
-			Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers) {
-		return new OpenAPIService(openAPI, securityParser, springDocConfigProperties, propertyResolverUtils, openApiBuilderCustomisers);
+			Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers,
+			Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomisers) {
+		return new OpenAPIService(openAPI, securityParser, springDocConfigProperties, propertyResolverUtils, openApiBuilderCustomisers, serverBaseUrlCustomisers);
 	}
 
 	/**
@@ -579,4 +581,4 @@ CloudFunctionProvider springCloudFunctionProvider(Optional<FunctionCatalog> func
 			return new SpringCloudFunctionProvider(functionCatalog, genericResponseService, springDocConfigProperties);
 		}
 	}
-}
+}

springdoc-openapi-common/src/main/java/org/springdoc/core/customizers/ServerBaseUrlCustomizer.java

@@ -0,0 +1,17 @@
+package org.springdoc.core.customizers;
+
+/**
+ * The interface Server Base URL customiser.
+ * @author skylar-stark
+ */
+@FunctionalInterface
+public interface ServerBaseUrlCustomizer {
+
+	/**
+	 * Customise.
+	 * 
+	 * @param serverBaseUrl the serverBaseUrl.
+	 * @return the customised serverBaseUrl
+	 */
+	public String customise(String serverBaseUrl);
+}

springdoc-openapi-common/src/test/java/org/springdoc/api/AbstractOpenApiResourceTest.java

@@ -111,6 +111,7 @@ public void setUp() {
 		openAPI = new OpenAPI();
 		openAPI.setPaths(new Paths().addPathItem(PATH, new PathItem()));
 		ReflectionTestUtils.setField(openAPIService, "cachedOpenAPI", new HashMap<>());
+		ReflectionTestUtils.setField(openAPIService, "serverBaseUrlCustomisers", Optional.empty());
 
 		when(openAPIService.getCalculatedOpenAPI()).thenReturn(openAPI);
 		when(openAPIService.getContext()).thenReturn(context);