luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-17 00:11:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: mark openapi support as alpha

Browse source
This commit is contained in:
Joel Kaasinen 2023-03-10 10:17:42 +02:00
parent 8c87fef7b6
commit 3fa50ea0f6
2 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/ring/openapi.md
View file

@ -1,5 +1,7 @@
# OpenAPI Support # OpenAPI Support
**Stability: alpha**
Reitit can generate [OpenAPI 3.1.0](https://spec.openapis.org/oas/v3.1.0) 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). documentation. The feature works similarly to [Swagger documentation](swagger.md).

8
modules/reitit-openapi/src/reitit/openapi.cljc
View file

@ -18,7 +18,9 @@
(s/def ::spec (s/keys :opt-un [::openapi ::no-doc ::tags ::summary ::description ::content-types])) (s/def ::spec (s/keys :opt-un [::openapi ::no-doc ::tags ::summary ::description ::content-types]))
(def openapi-feature (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 Works both with Middleware & Interceptors. Does not participate
in actual request processing, just provides specs for the new in actual request processing, just provides specs for the new
documentation keys for the route data. Should be accompanied by a documentation keys for the route data. Should be accompanied by a
@ -72,7 +74,9 @@
(-> path (trie/normalize opts) (str/replace #"\{\*" "{"))) (-> path (trie/normalize opts) (str/replace #"\{\*" "{")))
(defn create-openapi-handler (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." an intersecting `[:openapi :id]` and which are not marked with `:no-doc` route data."
[] []
(fn create-openapi (fn create-openapi