update swagger documentation generation

Author: fupelaqu

build.sbt

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

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

@@ -13,6 +13,10 @@ akka{
 
 softnetwork{
   api{
+    name = ""
+    name = ${?APP}
+    version = ""
+    version = ${?VERSION}
     server{
       interface = "0.0.0.0"
       interface = ${?HTTP_SERVER_INTERFACE}

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

@@ -1,7 +1,7 @@
 package app.softnetwork.api.server
 
 import akka.http.scaladsl.server.Route
-import app.softnetwork.persistence.{appName, version}
+import app.softnetwork.api.server.config.ServerSettings
 import sttp.capabilities.WebSockets
 import sttp.capabilities.akka.AkkaStreams
 import sttp.tapir.server.ServerEndpoint
@@ -15,10 +15,14 @@ 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)
+    endpointsToSwaggerEndpoints(endpoints, applicationName, applicationVersion)
 
   def swaggerRoute(implicit ec: ExecutionContext): Route = swaggerEndpoints
 
@@ -29,12 +33,14 @@ trait ApiEndpoint {
 object ApiEndpoint {
 
   def endpointsToSwaggerEndpoints(
-    endpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]]
+    endpoints: List[ServerEndpoint[AkkaStreams with WebSockets, Future]],
+    applicationName: String,
+    applicationVersion: String
   ): List[ServerEndpoint[AkkaStreams with WebSockets, Future]] =
     SwaggerInterpreter().fromEndpoints[Future](
       endpoints.map(_.endpoint.prependIn(config.ServerSettings.RootPath)),
-      appName,
-      version
+      applicationName,
+      applicationVersion
     )
 
   implicit def endpointsToRoute(

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

@@ -2,6 +2,7 @@ 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
@@ -12,12 +13,14 @@ 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)
+    eps ++ endpointsToSwaggerEndpoints(eps, applicationName, applicationVersion)
   }
 
 }

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

@@ -5,7 +5,7 @@ import akka.actor.typed.ActorSystem
 import akka.http.scaladsl.model.headers.RawHeader
 import akka.http.scaladsl.model.{HttpResponse, StatusCodes}
 import akka.http.scaladsl.server.{Directives, ExceptionHandler, Route}
-import app.softnetwork.persistence.version
+import app.softnetwork.api.server.config.ServerSettings
 import org.json4s.Formats
 import app.softnetwork.serialization._
 import org.slf4j.Logger
@@ -16,6 +16,8 @@ import scala.util.{Failure, Success, Try}
   */
 trait ApiRoutes extends Directives with GrpcServices with DefaultComplete {
 
+  val applicationVersion: String = ServerSettings.ApplicationVersion
+
   override implicit def formats: Formats = commonFormats
 
   def log: Logger
@@ -36,7 +38,7 @@ trait ApiRoutes extends Directives with GrpcServices with DefaultComplete {
       logRequestResult("RestAll") {
         pathPrefix(config.ServerSettings.RootPath) {
           Try(
-            respondWithHeaders(RawHeader("Api-Version", version)) {
+            respondWithHeaders(RawHeader("Api-Version", applicationVersion)) {
               HealthCheckService.route ~ apiRoutes(system)
             }
           ) match {

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

@@ -10,4 +10,7 @@ object ServerSettings {
   val Interface: String = config.getString("softnetwork.api.server.interface")
   val Port: Int = config.getInt("softnetwork.api.server.port")
   val RootPath: String = config.getString("softnetwork.api.server.root-path")
+
+  val ApplicationName: String = config.getString("softnetwork.api.name")
+  val ApplicationVersion: String = config.getString("softnetwork.api.version")
 }