mirror of
https://github.com/metosin/reitit.git
synced 2025-12-17 16:31:11 +00:00
doc: mark openapi support as alpha
This commit is contained in:
parent
8c87fef7b6
commit
3fa50ea0f6
2 changed files with 8 additions and 2 deletions
|
|
@ -1,5 +1,7 @@
|
|||
# OpenAPI Support
|
||||
|
||||
**Stability: alpha**
|
||||
|
||||
Reitit can generate [OpenAPI 3.1.0](https://spec.openapis.org/oas/v3.1.0)
|
||||
documentation. The feature works similarly to [Swagger documentation](swagger.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,9 @@
|
|||
(s/def ::spec (s/keys :opt-un [::openapi ::no-doc ::tags ::summary ::description ::content-types]))
|
||||
|
||||
(def openapi-feature
|
||||
"Feature for handling openapi-documentation for routes.
|
||||
"Stability: alpha
|
||||
|
||||
Feature for handling openapi-documentation for routes.
|
||||
Works both with Middleware & Interceptors. Does not participate
|
||||
in actual request processing, just provides specs for the new
|
||||
documentation keys for the route data. Should be accompanied by a
|
||||
|
|
@ -72,7 +74,9 @@
|
|||
(-> path (trie/normalize opts) (str/replace #"\{\*" "{")))
|
||||
|
||||
(defn create-openapi-handler
|
||||
"Create a ring handler to emit openapi spec. Collects all routes from router which have
|
||||
"Stability: alpha
|
||||
|
||||
Create a ring handler to emit openapi spec. Collects all routes from router which have
|
||||
an intersecting `[:openapi :id]` and which are not marked with `:no-doc` route data."
|
||||
[]
|
||||
(fn create-openapi
|
||||
|
|
|
|||
Loading…
Reference in a new issue