20 lines
1.1 KiB
Markdown
20 lines
1.1 KiB
Markdown
The Playground is a module inside the Kompendium repository that provides out of the box examples for a variety of
|
|
Kompendium features.
|
|
|
|
At the moment, the following playground applications are
|
|
|
|
| Example | Description |
|
|
|--------------|------------------------------------------------------------|
|
|
| Basic | A minimally viable Kompendium application |
|
|
| Auth | Documenting authenticated routes |
|
|
| Custom Types | Documenting custom scalars to be used by Kompendium |
|
|
| Exceptions | Documenting exception responses |
|
|
| Gson | Serialization using Gson instead of the default Kotlinx |
|
|
| Hidden Docs | Place your generated documentation behind authorization |
|
|
| Jackson | Serialization using Jackson instead of the default KotlinX |
|
|
| Resources | Using the Ktor Resources API to define routes |
|
|
|
|
You can find all of the playground
|
|
examples [here](https://github.com/bkbnio/kompendium/tree/main/playground/src/main/kotlin/io/bkbn/kompendium/playground)
|
|
in the Kompendium repository
|