tapir
v0.12.11
  • Quickstart
  • Examples
    • Other examples
    • Blogs, articles
    • Videos
  • 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
  • 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
  • Books example
  • ZIO example, using http4s
  • Streaming body, using akka-http

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 2019, SoftwareMill Revision 0eeccdcf.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v0.12.11
Versions
latest
stable
v1.2.9
v1.2.8
v1.2.7
v1.2.6
v1.2.5
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.1.4
v1.1.3
v1.1.2
v1.1.1
v1.1.0
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v1.0.0-rc3
v1.0.0-rc2
v1.0.0-rc1
v0.20.2
v0.20.1
v0.20.0_a
v0.20.0
v0.19.4_a
v0.19.4
v0.19.3
v0.19.2
v0.19.1
v0.19.0
v0.18.3
v0.18.2
v0.18.1
v0.18.0
v0.17.20
v0.17.19
v0.17.18
v0.17.17
v0.17.16
v0.17.15
v0.17.14
v0.17.13
v0.17.12
v0.17.11
v0.17.10
v0.17.9
v0.17.8
v0.17.7
v0.17.6
v0.17.5
v0.17.4
v0.17.3
v0.17.2
v0.17.1
v0.17.0
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.16.0
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.12.12
v0.12.11
v0.12.10
v0.12.9
v0.12.8
v0.12.7
v0.12.6
v0.12.5
v0.12.4
v0.12.3
v0.12.2
v0.12.1
v0.12.0
v0.11.11
v0.11.10
v0.11.9
v0.11.8
v0.11.7
v0.11.6
v0.11.5
v0.11.4
v0.11.3
v0.11.2
v0.11.1
v0.11.0
v0.10.1
v0.10.0
v0.9.3
v0.9.2
v0.9.1
v0.9.0
v0.8.11
v0.8.10
v0.8.9
v0.8.8
v0.8.7
v0.8.6
v0.8.5
v0.8.4
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.10
v0.7.9
v0.7.8
v0.7.7
v0.7.6
v0.7.5
v0.7.4
v0.7.3
v0.7.2
v0.7.1
v0.7
v0.6.2
v0.6.1
v0.6
v0.5.2
v0.5.1
v0.5
v0.4
v0.3
v0.2
vversion
v1.0.0-m9
v1.0.0-m8
v1.0.0-m7
v1.0.0-m6
v1.0.0-m5
v1.0.0-m4
v1.0.0-m3
v1.0.0-m2
v1.0.0-m1
v0.20.0-m9
v0.20.0-m8
v0.20.0-m7
v0.20.0-m7_a
v0.20.0-m6
v0.20.0-m5
v0.20.0-m4
v0.20.0-m3
v0.20.0-m2
v0.20.0-m10
v0.20.0-m1
v0.19.0-m9
v0.19.0-m8
v0.19.0-m7
v0.19.0-m6
v0.19.0-m5
v0.19.0-m4
v0.19.0-m3
v0.19.0-m2
v0.19.0-m16
v0.19.0-m15
v0.19.0-m14
v0.19.0-m13
v0.19.0-m12
v0.19.0-m11
v0.19.0-m10
v0.19.0-m1
v0.18.0-m9
v0.18.0-m8
v0.18.0-m7
v0.18.0-m6
v0.18.0-m5
v0.18.0-m4
v0.18.0-m3
v0.18.0-m2
v0.18.0-m18
v0.18.0-m17
v0.18.0-m16
v0.18.0-m15
v0.18.0-m14
v0.18.0-m13
v0.18.0-m12
v0.18.0-m11
v0.18.0-m10
v0.18.0-m1
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-m11
v0.17.0-m10
v0.17.0-m1
v0.1
v0.0.11
v0.0.10
v0.0.9
v0.0.8
v0.0.7
v0.0.6
v0.0.5
v0.0.4
v0.0.3
v0.0.2
v0.0.1
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.