tapir

1.x

Getting started

Quickstart
Generate a Tapir project
Adopters
Support & sponsorship
Scala 2, Scala 3; JVM, JS & Native

Tutorials

1. Hello, world!
2. Auto-generating OpenAPI docs
3. Using JSON bodies
4. Error handling
5. Multiple inputs & outputs
6. Error variants
7. Integration with cats-effect & http4s

How-to's

Examples by category
Articles, videos, other examples
Handling Delimited Path Parameters

Endpoints

Basics
Inputs/outputs
One-of variants
Codecs
Adding support for custom types
Schema derivation
Enumerations
Validation
Content type
Working with JSON
JSON Pickler
Working with XML
Forms
Security
Streaming support
Web sockets
Third-party datatype libraries integrations
Serving static content

Server interpreters

Overview of server integrations
Running as an akka-http server
Running as an http4s server
Running as an http4s server using ZIO
Running as a Netty-based server
Running as a Helidon Níma server
Running as a Finatra server
Running as a pekko-http server
Running as a Play server
Running as a Vert.X server
Running as a zio-http server
Running as an Armeria server
Running as a JDK http server
Running using the AWS serverless stack
Server options
Path matching
Interceptors
Server logic
Observability
Error handling
Logging & debugging

Client interpreters

Using as an sttp client
Using as a Play client
Using as an http4s client

Documentation interpreters

Generating OpenAPI documentation
Generating AsyncAPI documentation
Generating JSON Schema

Testing

Testing

Generators

Generate endpoint definitions from an OpenAPI YAML

Other subjects

Stability of modules
Other interpreters
Creating your own tapir
gRPC
Troubleshooting
Migrating
Architecture Decision Records
Goals of the project
Contributing

tapir

Architecture Decision Records
Edit on GitHub

Architecture Decision Records

ADRs covering some of Tapir’s design decisions are available in the adr directory of the repository. They are available here.

Previous Next

© Copyright 2024, SoftwareMill.

Built with Sphinx using a theme provided by Read the Docs.