tapir
v0.16.16

Getting started

  • Quickstart
  • Examples
    • Other examples
    • Blogs, articles
    • Videos
  • Goals of the project

Endpoints

  • Basics
  • Inputs/outputs
  • Status codes
  • Codecs
  • Custom types
  • Validation
  • Working with JSON
  • Forms
  • Authentication
  • Datatypes integrations
  • ZIO integration

Server interpreters

  • Running as an akka-http server
  • Running as an http4s server
  • Running as a Finatra server
  • Running as a Play server
  • Running as a Vert.X server
  • Server options
  • Server logic
  • Error handling
  • Debugging

Client interpreters

  • Using as an sttp client

Documentation interpreters

  • Generating OpenAPI documentation

Testing

  • Testing

Other subjects

  • Other interpreters
  • Creating your own Tapir
  • Troubleshooting
  • Contributing
tapir
  • Docs »
  • Examples
  • Edit on GitHub

Examples¶

The examples sub-project contains a number of runnable tapir usage examples:

  • Hello world server, using akka-http
  • Hello world server, using http4s
  • Separate error & success outputs, using akka-http
  • Multiple endpoints, exposing OpenAPI/Swagger documentation, using akka-http
  • Multiple endpoints, exposing OpenAPI/Swagger documentation, using http4s
  • Multiple endpoints, with the description coupled with server logic, using akka-http
  • Reporting errors in a custom format when a query/path/.. parameter cannot be decoded
  • Using custom types in endpoint descriptions
  • Multipart form upload, using akka-http
  • Partial server logic (authentication), using akka-http
  • Books example
  • ZIO example, using http4s
  • ZIO partial server logic example, using http4s
  • Streaming body, using akka-http
  • Streaming body, using http4s + fs2

Other examples¶

To see an example project using Tapir, check out this Todo-Backend using tapir and http4s.

Blogs, articles¶

  • Three easy endpoints
  • tAPIr’s Endpoint meets ZIO’s IO
  • Describe, then interpret: HTTP endpoints using tapir

Videos¶

  • ScalaWorld 2019: Designing Programmer-Friendly APIs
Next Previous

© Copyright 2020, SoftwareMill Revision dac193f3.

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