tapir

![tapir](https://github.com/softwaremill/tapir/raw/master/banner.png)

# Welcome!

[![Ideas, suggestions, problems, questions](https://img.shields.io/badge/Discourse-ask%20question-blue)](https://softwaremill.community/c/tapir)
[![CI](https://github.com/softwaremill/tapir/workflows/CI/badge.svg)](https://github.com/softwaremill/tapir/actions?query=workflow%3A%22CI%22)
[![Maven Central](https://maven-badges.sml.io/sonatype-central/com.softwaremill.sttp.tapir/tapir-core_3/badge.svg)](https://maven-badges.sml.io/sonatype-central/com.softwaremill.sttp.tapir/tapir-core_3/)

## Intro

Tapir is a library to describe HTTP APIs, expose them as a server, consume as a client, and automatically document
using open standards.

Tapir is fast and developer-friendly. The endpoint definition APIs are crafted with readability and discoverability in
mind. Our Netty-based server is one of the best-performing Scala HTTP servers available.

```scala
endpoint
  .get.in("hello").in(query[String]("name"))
  .out(stringBody)
  .handleSuccess(name => s"Hello, $name!")
```

Tapir integrates with all major Scala stacks, so you can use your favorite approach to Functional Programming, while
leveraging all the benefits that Tapir brings!

Seamless integration with the Scala and HTTP ecosystems is one of Tapir's major strengths:

* all popular Scala HTTP server implementations are supported. You can define your entire API using Tapir, or expose
  Tapir-managed routes alongside "native" ones. This is especially useful when gradually adopting Tapir, or using it for
  selected use-cases.
* the Scala ecosystem is rich with libraries leveraging its type-safety and enhancing the developer's toolbox,
  that's why Tapir provides integrations with many of such custom type, JSON and observability libraries
* documentation can be generated in the [OpenAPI](https://tapir.softwaremill.com/en/latest/docs/openapi.html), [AsyncAPI](https://tapir.softwaremill.com/en/latest/docs/asyncapi.html) and [JSON Schema](https://tapir.softwaremill.com/en/latest/docs/json-schema.html) formats

Depending on how you'd prefer to explore Tapir, this documentation has three main sections:

1. There's a number of [tutorials](https://tapir.softwaremill.com/en/latest/tutorials/01_hello_world.html), which provide a gentle introduction to the library
2. Nothing compares to tinkering with working code, that's why we've prepared [runnable examples](https://tapir.softwaremill.com/en/latest/examples.html),
   covering solutions to many "everyday" problems
3. Finally, the reference documentation describes all of Tapir's aspects in depth - take a look at the menu on
   the left, starting with the "Endpoints" section

## Documentation

Tapir documentation is available at [tapir.softwaremill.com](http://tapir.softwaremill.com).

## Why tapir?

* **type-safety**: compile-time guarantees, develop-time completions, read-time information
* **declarative**: separate the shape of the endpoint (the "what"), from the server logic (