tapir
v0.12.2
  • 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

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 094bd8f0.

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