tapir
v0.17.0-M10

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
  • Streaming support
  • Web sockets
  • 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
  • Using as a Play client

Documentation interpreters

  • Generating OpenAPI documentation
  • Generating AsyncAPI 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 example with environment, using http4s
  • ZIO partial server logic example, using http4s
  • Streaming body, using akka-http
  • Streaming body, using http4s + fs2
  • Web sockets server, using akka-http
  • Web sockets client, using akka-http
  • Web sockets server, using http4s

Other examples¶

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

For a quick start using http4s and tapir you can use a gitter8 template. A new project can be created using: sbt new https://codeberg.org/wegtam/http4s-tapir.g8.git

Blogs, articles¶

  • Designing tapir’s WebSockets support
  • 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 582debfa.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v0.17.0-M10
Versions
latest
stable
v0.16.16
v0.16.15
v0.16.14
v0.16.13
v0.16.12
v0.16.11
v0.16.10
v0.16.9
v0.16.7
v0.16.6
v0.16.5
v0.16.4
v0.16.3
v0.16.2
v0.16.1
v0.15.4
v0.15.3
v0.15.2
v0.15.1
v0.15.0
v0.14.5
v0.14.4
v0.14.3
v0.14.2
v0.14.1
v0.14.0
v0.13.2
v0.13.1
v0.13.0
v0.12.28
v0.12.27
v0.12.26
v0.12.24
v0.12.23
v0.12.22
v0.12.21
v0.12.20
v0.12.19
v0.12.18
v0.12.17
v0.12.16
v0.12.15
v0.12.14
v0.12.13
v0.11.11
v0.11.10
v0.11.9
v0.10.1
v0.9.3
v0.8.7
vversion
v0.17.0-m9
v0.17.0-m8
v0.17.0-m7
v0.17.0-m6
v0.17.0-m5
v0.17.0-m4
v0.17.0-m3
v0.17.0-m2
v0.17.0-m10
v0.17.0-m1
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.