major refactoring of endpoints api - add trait for swagger api

Author: fupelaqu

build.sbt

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

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

@@ -1,28 +1,24 @@
 package app.softnetwork.api.server
 
 import akka.http.scaladsl.server.Route
-import app.softnetwork.api.server.config.ServerSettings
 import app.softnetwork.serialization.commonFormats
 import org.json4s.Formats
 import sttp.capabilities.WebSockets
 import sttp.capabilities.akka.AkkaStreams
 import sttp.tapir.server.ServerEndpoint
 import sttp.tapir.server.akkahttp.AkkaHttpServerInterpreter
-import sttp.tapir.swagger.bundle.SwaggerInterpreter
-import sttp.tapir._
-import sttp.tapir.swagger.SwaggerUIOptions
 
 import scala.concurrent.{ExecutionContext, Future}
 import scala.language.implicitConversions
 
-trait ApiEndpoint {
+trait ApiEndpoint extends SwaggerApiEndpoint {
 
   import ApiEndpoint._
 
   def endpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]]
 
   def swaggerEndpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]] =
-    endpointsToSwaggerEndpoints(endpoints, swaggerUIOptions)
+    endpointsToSwaggerEndpoints(endpoints)
 
   def swaggerRoute(implicit ec: ExecutionContext): Route = swaggerEndpoints
 
@@ -34,24 +30,6 @@ 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]],
-    swaggerUIOptions: SwaggerUIOptions
-  ): List[ServerEndpoint[AkkaStreams with WebSockets, Future]] =
-    SwaggerInterpreter(swaggerUIOptions = swaggerUIOptions).fromEndpoints[Future](
-      endpoints.map(_.endpoint.prependIn(config.ServerSettings.RootPath)),
-      applicationName,
-      applicationVersion
-    )
-
   implicit def endpointsToRoute(
     endpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]]
   )(implicit

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

@@ -2,22 +2,16 @@ package app.softnetwork.api.server
 
 import akka.actor.typed.ActorSystem
 import akka.http.scaladsl.server.Route
-import sttp.capabilities.WebSockets
-import sttp.capabilities.akka.AkkaStreams
-import sttp.tapir.server.ServerEndpoint
 
-import scala.concurrent.{ExecutionContext, Future}
+import scala.concurrent.ExecutionContext
 
 trait ApiEndpoints extends ApiRoutes {
 
-  import ApiEndpoint._
-
-  def endpoints: ActorSystem[_] => List[ServerEndpoint[AkkaStreams with WebSockets, Future]]
+  def endpoints: ActorSystem[_] => List[ApiEndpoint]
 
   override def apiRoutes(system: ActorSystem[_]): Route = {
     implicit def ec: ExecutionContext = system.executionContext
-    val eps = endpoints(system)
-    eps ++ endpointsToSwaggerEndpoints(eps, swaggerUIOptions)
+    concat(endpoints(system).map(api => api.apiRoute ~ api.swaggerRoute): _*)
   }
 
 }

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

@@ -6,15 +6,13 @@ import app.softnetwork.persistence.service.Service
 import app.softnetwork.persistence.typed.scaladsl.EntityPattern
 import sttp.tapir.generic.auto.SchemaDerivation
 import sttp.tapir.Tapir
-import sttp.tapir.json.json4s.TapirJson4s
 
 import scala.language.implicitConversions
 
 trait ServiceEndpoints[C <: Command, R <: CommandResult]
     extends ApiEndpoint
     with Tapir
     with SchemaDerivation
-    with TapirJson4s
     with Service[C, R]
     with Completion { _: EntityPattern[C, R] =>
 

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

@@ -0,0 +1,31 @@
+package app.softnetwork.api.server
+
+import app.softnetwork.api.server.config.ServerSettings
+import sttp.capabilities.WebSockets
+import sttp.capabilities.akka.AkkaStreams
+import sttp.tapir.server.ServerEndpoint
+import sttp.tapir.swagger.SwaggerUIOptions
+import sttp.tapir.swagger.bundle.SwaggerInterpreter
+
+import scala.concurrent.Future
+
+trait SwaggerApiEndpoint {
+
+  val applicationName: String = ServerSettings.ApplicationName
+
+  val applicationVersion: String = ServerSettings.ApplicationVersion
+
+  val swaggerPathPrefix: List[String] = config.ServerSettings.SwaggerPathPrefix
+
+  val swaggerUIOptions: SwaggerUIOptions = SwaggerUIOptions.default.pathPrefix(swaggerPathPrefix)
+
+  def endpointsToSwaggerEndpoints(
+    endpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]]
+  ): List[ServerEndpoint[AkkaStreams with WebSockets, Future]] =
+    SwaggerInterpreter(swaggerUIOptions = swaggerUIOptions).fromEndpoints[Future](
+      endpoints.map(_.endpoint.prependIn(config.ServerSettings.RootPath)),
+      applicationName,
+      applicationVersion
+    )
+
+}

session/testkit/src/main/scala/app/softnetwork/session/scalatest/SessionEndpointsRoutes.scala

@@ -1,25 +1,19 @@
 package app.softnetwork.session.scalatest
 
 import akka.actor.typed.ActorSystem
-import app.softnetwork.api.server.ApiEndpoints
+import app.softnetwork.api.server.{ApiEndpoint, ApiEndpoints}
 import app.softnetwork.session.service.SessionEndpoints
 import com.softwaremill.session.CsrfCheck
 import org.scalatest.Suite
-import sttp.capabilities
-import sttp.capabilities.akka.AkkaStreams
-import sttp.tapir.server.ServerEndpoint
-
-import scala.concurrent.Future
 
 trait SessionEndpointsRoutes extends ApiEndpoints { _: CsrfCheck =>
   def sessionEndpoints: ActorSystem[_] => SessionEndpoints
 
   def sessionServiceEndpoints: ActorSystem[_] => SessionEndpointsRoute = system =>
     SessionEndpointsRoute(system, sessionEndpoints(system))
 
-  override def endpoints
-    : ActorSystem[_] => List[ServerEndpoint[AkkaStreams with capabilities.WebSockets, Future]] =
-    system => sessionServiceEndpoints(system).endpoints
+  override def endpoints: ActorSystem[_] => List[ApiEndpoint] = system =>
+    List(sessionServiceEndpoints(system))
 
 }