update swagger ui options adding swagger path prefix

Author: fupelaqu

build.sbt

@@ -30,7 +30,7 @@ ThisBuild / organization := "app.softnetwork"
 
 name := "generic-persistence-api"
 
-ThisBuild / version := "0.3.2.3"
+ThisBuild / version := "0.3.2.4"
 
 ThisBuild / scalaVersion := "2.12.11"
 

server/src/main/resources/softnetwork-api-server.conf

@@ -25,6 +25,8 @@ softnetwork{
       port      = ${?HTTP_SERVER_PORT}
 
       root-path = "api"
+
+      swagger-path-prefix = ["docs"]
     }
   }
 }

server/src/main/scala/app/softnetwork/api/server/ApiEndpoint.scala

@@ -14,6 +14,7 @@ import sttp.tapir.swagger.bundle.SwaggerInterpreter
 import sttp.tapir.generic.auto._
 import sttp.tapir.json.json4s.jsonBody
 import sttp.tapir._
+import sttp.tapir.swagger.SwaggerUIOptions
 
 import scala.concurrent.{ExecutionContext, Future}
 import scala.language.implicitConversions
@@ -22,14 +23,10 @@ trait ApiEndpoint {
 
   import ApiEndpoint._
 
-  val applicationName: String = ServerSettings.ApplicationName
-
-  val applicationVersion: String = ServerSettings.ApplicationVersion
-
   def endpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]]
 
   def swaggerEndpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]] =
-    endpointsToSwaggerEndpoints(endpoints, applicationName, applicationVersion)
+    endpointsToSwaggerEndpoints(endpoints, swaggerUIOptions)
 
   def swaggerRoute(implicit ec: ExecutionContext): Route = swaggerEndpoints
 
@@ -80,12 +77,20 @@ trait ApiEndpoint {
 
 object ApiEndpoint {
 
+  val applicationName: String = ServerSettings.ApplicationName
+
+  val applicationVersion: String = ServerSettings.ApplicationVersion
+
+  val swaggerUIOptions: SwaggerUIOptions =
+    SwaggerUIOptions
+      .default
+      .pathPrefix(config.ServerSettings.SwaggerPathPrefix)
+
   def endpointsToSwaggerEndpoints(
     endpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]],
-    applicationName: String,
-    applicationVersion: String
+    swaggerUIOptions: SwaggerUIOptions
   ): List[ServerEndpoint[AkkaStreams with WebSockets, Future]] =
-    SwaggerInterpreter().fromEndpoints[Future](
+    SwaggerInterpreter(swaggerUIOptions = swaggerUIOptions).fromEndpoints[Future](
       endpoints.map(_.endpoint.prependIn(config.ServerSettings.RootPath)),
       applicationName,
       applicationVersion

server/src/main/scala/app/softnetwork/api/server/ApiEndpoints.scala

@@ -2,7 +2,6 @@ package app.softnetwork.api.server
 
 import akka.actor.typed.ActorSystem
 import akka.http.scaladsl.server.Route
-import app.softnetwork.api.server.config.ServerSettings
 import sttp.capabilities.WebSockets
 import sttp.capabilities.akka.AkkaStreams
 import sttp.tapir.server.ServerEndpoint
@@ -13,14 +12,12 @@ trait ApiEndpoints extends ApiRoutes {
 
   import ApiEndpoint._
 
-  val applicationName: String = ServerSettings.ApplicationName
-
   def endpoints: ActorSystem[_] => List[ServerEndpoint[AkkaStreams with WebSockets, Future]]
 
   override def apiRoutes(system: ActorSystem[_]): Route = {
     implicit def ec: ExecutionContext = system.executionContext
     val eps = endpoints(system)
-    eps ++ endpointsToSwaggerEndpoints(eps, applicationName, applicationVersion)
+    eps ++ endpointsToSwaggerEndpoints(eps, swaggerUIOptions)
   }
 
 }

server/src/main/scala/app/softnetwork/api/server/config/ServerSettings.scala

@@ -1,6 +1,7 @@
 package app.softnetwork.api.server.config
 
 import com.typesafe.config.{Config, ConfigFactory}
+import scala.collection.JavaConverters._
 
 object ServerSettings {
 
@@ -11,6 +12,9 @@ object ServerSettings {
   val Port: Int = config.getInt("softnetwork.api.server.port")
   val RootPath: String = config.getString("softnetwork.api.server.root-path")
 
+  val SwaggerPathPrefix: List[String] =
+    config.getStringList("softnetwork.api.server.swagger-path-prefix").asScala.toList
+
   val ApplicationName: String = config.getString("softnetwork.api.name")
   val ApplicationVersion: String = config.getString("softnetwork.api.version")
 }

session/common/build.sbt

@@ -10,7 +10,7 @@ val akkaHttpSession: Seq[ModuleID] = Seq(
 )
 
 libraryDependencies ++= Seq(
-  "app.softnetwork.protobuf" %% "scalapb-extensions" % "0.1.6"
+  "app.softnetwork.protobuf" %% "scalapb-extensions" % "0.1.7"
 ) ++ akkaHttpSession
 
 Compile / unmanagedResourceDirectories += baseDirectory.value / "src/main/protobuf"