Skip to content

Files

Latest commit

 

History

History
26 lines (17 loc) · 581 Bytes

quickstart.md

File metadata and controls

26 lines (17 loc) · 581 Bytes

Quickstart

To use tapir, add the following dependency to your project:

"com.softwaremill.sttp.tapir" %% "tapir-core" % "@VERSION@"

This will import only the core classes needed to create endpoint descriptions. To generate a server or a client, you will need to add further dependencies.

Many of tapir functionalities come as builder methods in the main package, hence it's easiest to work with tapir if you import the main package entirely, i.e.:

import sttp.tapir.*

Finally, type:

endpoint.

and see where auto-complete gets you!