Example: respond with 404 if None returned from server logic #4257
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adamw
reviewed
Jan 10, 2025
| @@ -56,6 +57,16 @@ import sttp.tapir.generic.auto.* | |||
| val booksListingByGenre: PublicEndpoint[BooksQuery, String, Vector[Book], Any] = baseEndpoint.get | |||
| .in(("list" / path[String]("genre").map(Option(_))(_.get)).and(limitParameter).mapTo[BooksQuery]) | |||
| .out(jsonBody[Vector[Book]]) | |||
|
|
|||
| // Optional value from serverLogic, responding with 404 when None | |||
There was a problem hiding this comment.
let's create a stand-alone, separate example. Otherwise this one will become a monster-example ;)
… None and 200 and body for Some
This reverts commit 746ad5f.
adamw
reviewed
Jan 14, 2025
| @@ -0,0 +1,131 @@ | |||
| // {cat=Optional value; effects=Future; server=Pekko HTTP; JSON=circe; docs=Swagger UI}: Optional returned from the server logic, resulting in 404 if None | |||
There was a problem hiding this comment.
Let's put it in the "Error handling" category (https://tapir.softwaremill.com/en/latest/examples.html)
|
There's a lot that is copied from the books example, the example can be greatly simplified - by keeping only the crucial parts (a simply case class, json serialization to None/Some). Everything else just obscure the image :) |
|
It should be better now - much code removed |
adamw
reviewed
Jan 14, 2025
| .out(oneOf( | ||
| oneOfVariantExactMatcher(StatusCode.NotFound, jsonBody[Option[Beer]])(None), | ||
| oneOfVariantValueMatcher(StatusCode.Ok, jsonBody[Option[Beer]]) { | ||
| case Some(book) => true |
adamw
reviewed
Jan 14, 2025
| @@ -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 | |||
adamw
reviewed
Jan 14, 2025
| } | ||
|
|
||
|
|
||
| implicit val actorSystem: ActorSystem = ActorSystem() |
There was a problem hiding this comment.
we're in scala 3, should be given
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.