https://github.com/gaeljw/tapir-play-sample
Sample project using Play Framework + Tapir
https://github.com/gaeljw/tapir-play-sample
endpoints play playframework scala tapir
Last synced: about 1 year ago
JSON representation
Sample project using Play Framework + Tapir
- Host: GitHub
- URL: https://github.com/gaeljw/tapir-play-sample
- Owner: gaeljw
- License: mit
- Created: 2020-08-30T15:46:54.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-14T03:40:09.000Z (about 1 year ago)
- Last Synced: 2025-03-14T04:28:19.707Z (about 1 year ago)
- Topics: endpoints, play, playframework, scala, tapir
- Language: Scala
- Homepage:
- Size: 306 KB
- Stars: 14
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# tapir-play-sample
Sample project using [Play Framework](https://github.com/playframework) + [Tapir](https://github.com/softwaremill/tapir) (including OpenAPI documentation).
**Contributions are welcomed!** If you find this project useful but think it could contain more useful examples (and it sure could ;)), please open an issue or a pull request.
_Note: consider this project as a showcase._
_You can structure things differently for a real-life project._
## 📖 Guided tour
For a guided tour of how to use Tapir with Play Framework,
you can read the following article: https://medium.com/@gaeljw/using-tapir-in-a-play-framework-application-d75a93d85030
## 🚀 Try it!
```
sbt run
```
And go to http://localhost:9000/docs/.
## ✅ Content
- Basic endpoints with shared logic, see `BookEndpoints`
- Reading input body
- Reading input authentication headers and shared authentication logic
- Sending output body and errors
- Streaming request/response
- With multiple formats for output and supporting complex `Accept` headers
- Swagger Documentation, see `ApiDocumentation`
## 📜 Changelog
See [here](./CHANGELOG.md).