Merge pull request #714 from overture-stack/rc/4.5.0

rc 4.5.0 Configurable swagger to run behind reverse proxy
overture-stack · Mar 23, 2021 · e22e55a · e22e55a
2 parents 52fe057 + 295e8f6
commit e22e55a
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 10 deletions.
diff --git a/pom.xml b/pom.xml
@@ -21,7 +21,7 @@
     <groupId>bio.overture</groupId>
     <artifactId>song</artifactId>
     <packaging>pom</packaging>
-    <version>4.4.0</version>
+    <version>4.5.0</version>
     <modules>
         <module>song-core</module>
         <module>song-java-sdk</module>

diff --git a/song-client/pom.xml b/song-client/pom.xml
@@ -18,7 +18,7 @@
 	<parent>
 		<artifactId>song</artifactId>
 		<groupId>bio.overture</groupId>
-		<version>4.4.0</version>
+		<version>4.5.0</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 
@@ -35,12 +35,12 @@
 		<dependency>
 			<groupId>bio.overture</groupId>
 			<artifactId>song-java-sdk</artifactId>
-			<version>4.4.0</version>
+			<version>4.5.0</version>
 		</dependency>
 		<dependency>
 			<groupId>bio.overture</groupId>
 			<artifactId>song-core</artifactId>
-			<version>4.4.0</version>
+			<version>4.5.0</version>
 		</dependency>
 
 		<!-- CLI -->

diff --git a/song-core/pom.xml b/song-core/pom.xml
@@ -19,7 +19,7 @@
 	<parent>
 		<artifactId>song</artifactId>
 		<groupId>bio.overture</groupId>
-		<version>4.4.0</version>
+		<version>4.5.0</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 

diff --git a/song-java-sdk/pom.xml b/song-java-sdk/pom.xml
@@ -18,7 +18,7 @@
 	<parent>
 		<artifactId>song</artifactId>
 		<groupId>bio.overture</groupId>
-		<version>4.4.0</version>
+		<version>4.5.0</version>
 	</parent>
 	<modelVersion>4.0.0</modelVersion>
 

diff --git a/song-server/pom.xml b/song-server/pom.xml
@@ -19,7 +19,7 @@
     <parent>
         <artifactId>song</artifactId>
         <groupId>bio.overture</groupId>
-        <version>4.4.0</version>
+        <version>4.5.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -37,7 +37,7 @@
         <dependency>
             <groupId>bio.overture</groupId>
             <artifactId>song-core</artifactId>
-            <version>4.4.0</version>
+            <version>4.5.0</version>
         </dependency>
 
         <!-- Spring -->

diff --git a/song-server/src/main/java/bio/overture/song/server/config/SwaggerConfig.java b/song-server/src/main/java/bio/overture/song/server/config/SwaggerConfig.java
@@ -27,6 +27,7 @@
 import springfox.documentation.builders.ApiInfoBuilder;
 import springfox.documentation.service.ApiInfo;
 import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.paths.RelativePathProvider;
 import springfox.documentation.spring.web.plugins.Docket;
 import springfox.documentation.swagger.web.UiConfiguration;
 import springfox.documentation.swagger2.annotations.EnableSwagger2;
@@ -42,15 +43,30 @@ public class SwaggerConfig {
   @Getter
   private String alternateSwaggerUrl;
 
+  // default is empty
+  @Value("${swagger.host:}")
+  private String swaggerHost;
+
+  // default is empty
+  @Value("${swagger.basePath:}")
+  private String basePath;
+
   @Bean
   public Docket api() {
     return new Docket(DocumentationType.SWAGGER_2)
         .apiInfo(apiInfo())
         .select()
         .apis(basePackage("bio.overture.song.server.controller"))
-        .paths(any())
         .build()
-        .pathMapping("/");
+        .host(swaggerHost)
+        .pathProvider(
+            new RelativePathProvider(null) {
+                @Override
+                public String getApplicationBasePath() {
+                  return basePath;
+                }
+            }
+        );
   }
 
   @Bean

diff --git a/song-server/src/main/resources/application.yml b/song-server/src/main/resources/application.yml
@@ -80,6 +80,11 @@ management:
 
 swagger:
   alternateUrl: "/api-docs"
+  # host and base url are needed if you run song behind a reverse proxy
+  # and rewrite the url eg: http://mydomain.com/song/swagger-ui.html
+  # in this case host = mydomain.com, baseUrl = /song
+  host: ""
+  basePath: ""
 
 security.basic.enabled: false