feat: swagger & OpenAPI docs endpoints

SwissDataScienceCenter · Feb 8, 2024 · e6ed2f5 · e6ed2f5
1 parent 19b86fb
commit e6ed2f5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/build.sbt b/build.sbt
@@ -259,7 +259,8 @@ lazy val searchApi = project
       Dependencies.ciris ++
         Dependencies.http4sDsl ++
         Dependencies.http4sServer ++
-        Dependencies.tapirHttp4sServer
+        Dependencies.tapirHttp4sServer ++
+        Dependencies.tapirOpenAPi
   )
   .dependsOn(
     commons % "compile->compile;test->test",

diff --git a/modules/search-api/src/main/scala/io/renku/search/api/HttpApplication.scala b/modules/search-api/src/main/scala/io/renku/search/api/HttpApplication.scala
@@ -30,6 +30,7 @@ import org.http4s.{HttpApp, HttpRoutes, Response}
 import sttp.tapir.*
 import sttp.tapir.server.ServerEndpoint
 import sttp.tapir.server.http4s.Http4sServerInterpreter
+import sttp.tapir.swagger.bundle.SwaggerInterpreter
 
 object HttpApplication:
   def apply[F[_]: Async: Network](
@@ -45,7 +46,7 @@ class HttpApplication[F[_]: Async](searchApi: SearchApi[F])
     Router[F]("/" -> routes).orNotFound
 
   private lazy val routes: HttpRoutes[F] =
-    Http4sServerInterpreter[F]().toRoutes(endpoints)
+    Http4sServerInterpreter[F]().toRoutes(endpoints ::: swaggerEndpoints)
 
   private lazy val endpoints: List[ServerEndpoint[Any, F]] =
     List(
@@ -60,8 +61,13 @@ class HttpApplication[F[_]: Async](searchApi: SearchApi[F])
       .in("api" / query)
       .errorOut(borerJsonBody[String])
       .out(borerJsonBody[List[Project]])
+      .description("Search API for searching Renku entities")
 
   private lazy val pingEndpoint: PublicEndpoint[Unit, Unit, String, Any] =
     endpoint.get
       .in("ping")
       .out(stringBody)
+      .description("Ping")
+
+  private lazy val swaggerEndpoints =
+    SwaggerInterpreter().fromServerEndpoints[F](endpoints, "Search API", "0.0.1")
diff --git a/project/Dependencies.scala b/project/Dependencies.scala
@@ -106,4 +106,7 @@ object Dependencies {
   val tapirHttp4sServer = Seq(
     "com.softwaremill.sttp.tapir" %% "tapir-http4s-server" % V.tapir
   )
+  val tapirOpenAPi = Seq(
+    "com.softwaremill.sttp.tapir" %% "tapir-swagger-ui-bundle" % V.tapir
+  )
 }