tapir, or Typed API descRiptions¶
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: sttp.
- documentation. Currently supported: OpenAPI.
Tapir is licensed under Apache2, the source code is available of GitHub.
Depending on how you prefer to explore the library, take a look at one of the examples or read on for a more detailed description of how tapir works!
- Goals of the project
- Endpoints: basics
- Endpoints: inputs/outputs
- Endpoints: status codes
- Endpoints: codecs
- Endpoints: custom types
- Endpoints: validation
- Endpoints: working with JSON
- Endpoints: forms
- Endpoints: authentication
- Servers: akka-http interpreter
- Servers: http4s interpreter
- Servers: finatra interpreter
- Servers: options
- Servers: logic
- Servers: error handling
- Servers: debugging
- Clients: sttp client interpreter
- Other interpreters
- Documentation: openapi interpreter
- Create your own tapir
Other sttp projects¶
sttp 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)