Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example: respond with 404 if None returned from server logic #4257

Merged
merged 5 commits into from
Jan 15, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Much code removed, example category changed to "Error handling"
amorfis committed Jan 14, 2025
commit ee99d8a0f4d70cb830a2a4ec0280dcf9b34efe27
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
// {cat=Error handling; effects=Future; server=Pekko HTTP; JSON=circe; docs=Swagger UI}: Optional returned from the server logic, resulting in 404 if None
amorfis marked this conversation as resolved.
Show resolved Hide resolved

//> using dep com.softwaremill.sttp.tapir::tapir-core:1.11.12
//> using dep com.softwaremill.sttp.tapir::tapir-pekko-http-server:1.11.12
//> using dep com.softwaremill.sttp.tapir::tapir-json-circe:1.11.12
//> using dep com.softwaremill.sttp.client3::core:3.10.2

package sttp.tapir.examples.errors

import io.circe.generic.auto.*
import io.circe.parser.parse
import org.apache.pekko.actor.ActorSystem
import org.apache.pekko.http.scaladsl.Http
import sttp.client3.{HttpURLConnectionBackend, Identity, SttpBackend, UriContext, basicRequest}
import sttp.model.StatusCode
import sttp.tapir.*
import sttp.tapir.generic.auto.*
import sttp.tapir.json.circe.*
import sttp.tapir.server.pekkohttp.PekkoHttpServerInterpreter

import scala.concurrent.{Await, Future}
import scala.concurrent.duration.*

@main def optionalValueExample(): Unit =

case class Beer(name: String, volumeInLiters: Double)

val bartenderEndpoint = endpoint
.get
.in("beer" / query[Int]("age"))
// Optional value from serverLogic, responding with 404 "Not Found" when logic returns None
.out(oneOf(
oneOfVariantExactMatcher(StatusCode.NotFound, jsonBody[Option[Beer]])(None),
oneOfVariantValueMatcher(StatusCode.Ok, jsonBody[Option[Beer]]) {
case Some(book) => true
amorfis marked this conversation as resolved.
Show resolved Hide resolved
}
))

//

val bartenderServerEndpoint = bartenderEndpoint.serverLogic {
case a if a < 18 => Future.successful(Right(None))
case _ => Future.successful(Right(Some(Beer("IPA", 0.5))))
}


implicit val actorSystem: ActorSystem = ActorSystem()
amorfis marked this conversation as resolved.
Show resolved Hide resolved
import actorSystem.dispatcher
val routes = PekkoHttpServerInterpreter().toRoute(bartenderServerEndpoint)

val serverBinding = Http().newServerAt("localhost", 8080).bindFlow(routes).map { binding =>
val backend: SttpBackend[Identity, Any] = HttpURLConnectionBackend()

val response1 = basicRequest.get(uri"http://localhost:8080/beer?age=15").send(backend)
assert(response1.code == StatusCode.NotFound)

val response2 = basicRequest.get(uri"http://localhost:8080/beer?age=21").send(backend)
println("Got result: " + response2.body)
val beerEither = response2.body.flatMap(parse).flatMap(_.as[Beer])
assert(beerEither == Right(Beer("IPA", 0.5)))

binding
}

val _ = Await.result(serverBinding, 1.minute)

This file was deleted.