Merge pull request #195 from overture-stack/feat/custom-swagger-servers

add ability to customize server url

Author: blabadi

maestro-app/src/main/java/bio/overture/maestro/app/infra/config/RootConfiguration.java

@@ -29,12 +29,18 @@
 import bio.overture.maestro.app.infra.config.properties.PropertiesConfig;
 import bio.overture.maestro.domain.api.DomainApiConfig;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.servers.Server;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.context.annotation.Primary;
 import org.springframework.web.reactive.function.client.WebClient;
 
+import java.util.List;
+
 /** Aggregates all configuration in one place */
 @Configuration
 @Import({
@@ -97,4 +103,12 @@ class WebConfig {
   public ObjectMapper objectMapper() {
     return new ObjectMapper();
   }
+
+  @Bean
+  @ConditionalOnProperty(name = "springdoc.serverOverride.enabled", havingValue = "true")
+  public OpenAPI maestroOpenApi(@Value("${springdoc.serverOverride.value}") String serverOverride) {
+    return new OpenAPI()
+        .servers(List.of(new Server().url(serverOverride)));
+  }
+
 }

maestro-app/src/main/resources/config/application.yml

@@ -172,5 +172,13 @@ spring:
             maxAttempts: 1
 
 springdoc:
+  ## The reason this was added to support reverse proxy url rewrites like: http://xyz.com/maestro
+  ## otherwise the swagger urls will not be sent to the correct url since swagger ui depends
+  ## on the server definition and springdoc needs forward headers to be enabled by spring
+  ## enabling forward headers in maestro caused it to conflict with disabling kafka
+  ## and forced an autoconfigure for kafka client.
+  serverOverride:
+    enabled: false
+    value: http://localhost:11235/custom
   swagger-ui:
-    path: /api-docs
+    path: /api-docs