With tapir, you can describe HTTP API endpoints as immutable Scala values. Each endpoint can contain a number of input parameters, error-output parameters, and normal-output parameters. An endpoint specification can be interpreted as:
- a server, given the "business logic": a function, which computes output parameters based on input parameters. Currently supported:
- a client, which is a function from input parameters to output parameters. Currently supported:
- documentation. Currently supported:
import sttp.tapir._
import sttp.tapir.generic.auto._
import sttp.tapir.json.circe._
import io.circe.generic.auto._
type Limit = Int
type AuthToken = String
case class BooksFromYear(genre: String, year: Int)
case class Book(title: String)
// Define an endpoint
val booksListing: Endpoint[(BooksFromYear, Limit, AuthToken), String, List[Book], Any] =
endpoint
.get
.in(("books" / path[String]("genre") / path[Int]("year")).mapTo[BooksFromYear])
.in(query[Limit]("limit").description("Maximum number of books to retrieve"))
.in(header[AuthToken]("X-Auth-Token"))
.errorOut(stringBody)
.out(jsonBody[List[Book]])
// Generate OpenAPI documentation
import sttp.tapir.docs.openapi.OpenAPIDocsInterpreter
import sttp.tapir.openapi.circe.yaml._
val docs = OpenAPIDocsInterpreter.toOpenAPI(booksListing, "My Bookshop", "1.0")
println(docs.toYaml)
// Convert to akka-http Route
import sttp.tapir.server.akkahttp.AkkaHttpServerInterpreter
import akka.http.scaladsl.server.Route
import scala.concurrent.Future
def bookListingLogic(bfy: BooksFromYear,
limit: Limit,
at: AuthToken): Future[Either[String, List[Book]]] =
Future.successful(Right(List(Book("The Sorrows of Young Werther"))))
val booksListingRoute: Route = AkkaHttpServerInterpreter
.toRoute(booksListing)((bookListingLogic _).tupled)
// Convert to sttp Request
import sttp.tapir.client.sttp.SttpClientInterpreter
import sttp.client3._
val booksListingRequest: Request[DecodeResult[Either[String, List[Book]]], Any] =
SttpClientInterpreter
.toRequest(booksListing, Some(uri"http://localhost:8080"))
.apply((BooksFromYear("SF", 2016), 20, "xyz-abc-123"))tapir documentation is available at tapir.softwaremill.com.
Add the following dependency:
"com.softwaremill.sttp.tapir" %% "tapir-core" % "0.18.0-M17"You'll need partial unification enabled in the compiler (alternatively, you'll need to manually provide type arguments in some cases):
scalacOptions += "-Ypartial-unification"Then, import:
import sttp.tapir._And finally, type endpoint. and see where auto-complete gets you!
Sidenote for scala 2.12.4 and higher: if you encounter an issue with compiling your project because of
a StackOverflowException related to this scala bug,
please increase your stack memory. Example:
sbt -J-Xss4M clean compilesttp is a family of Scala HTTP-related projects, and currently includes:
- sttp client: the Scala HTTP client you always wanted!
- sttp tapir: this project
- sttp model: simple HTTP model classes (used by client & tapir)
Tapir is an early stage project. Everything might change. All suggestions welcome :)
See the list of issues and pick one! Or report your own.
If you are having doubts on the why or how something works, don't hesitate to ask a question on gitter or via github. This probably means that the documentation, scaladocs or code is unclear and be improved for the benefit of all.
The JS tests use Gecko instead of Chrome, although this causes another problem: out of memory when running JS tests for multiple modules. Work-arounds:
- run only JVM tests using
testJVM - test single JS projects
- use CI (GitHub Actions) to test all projects - the
.github/workflows/ci.ymlenumerates them one by one
You can test only server/client/doc/other projects using testServers, testClients, testDocs and testOther.
We offer commercial support for tapir and related technologies, as well as development services. Contact us to learn more about our offer!
Copyright (C) 2018-2021 SoftwareMill https://softwaremill.com.