naijun0403/kompendium
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: initial gitbook docs (#336)

Browse Source
This commit is contained in:
Ryan Brink
2022-09-29 21:36:48 -05:00
committed by GitHub
parent 622dd6a5e7
commit 1759be5ba3
10 changed files with 474 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/plugins/index.md Normal file
View File

@ -0,0 +1,11 @@
Plugins are the lifeblood of Kompendium.
It starts with the `NotarizedApplication`, where Kompendium is instantiated and attached to the API. This is where spec
metadata is defined, custom types are defined, and more.
From there, a `NotarizedRoute` plugin is attached to each route you wish to document. This allows API documentation to
be an iterative process. Each route you notarize will be picked up and injected into the OpenAPI spec that Kompendium
generates for you.
Finally, there is the `NotarizedLocations` plugin that allows you to leverage and document your usage of the
Ktor [Locations](https://ktor.io/docs/locations.html) API.