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: openapi named schemas only produced for malli

Browse source
This commit is contained in:
Joel Kaasinen 2024-11-28 09:51:31 +02:00
parent 0f9414847a
commit 431242c926
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/ring/openapi.md
View file

@ -5,6 +5,7 @@
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).
The main example is [examples/openapi](../../examples/openapi).
The The
[ring-malli-swagger](../../examples/ring-malli-swagger) [ring-malli-swagger](../../examples/ring-malli-swagger)
and and
@ -194,3 +195,16 @@ represents query parameters.
{:parameters {:query [:map {:parameters {:query [:map
[:a {:json-schema/example 1} :int]]}} [:a {:json-schema/example 1} :int]]}}
``` ```
### Named schemas
OpenAPI supports reusable schema objects that can be referred to with
the `"$ref": "#/components/schemas/Foo"` json-schema syntax. This is
useful when you have multiple endpoints that use the same schema. It
can also make OpenAPI-based code nicer for consumers of your API.
Reusable schema objects are generated for Malli `:ref`s and vars. The
[openapi example](../../examples/openapi) showcases this.
Currently (as of 0.7.2), reusable schema objects are **not** generated
for Plumatic Schema or Spec.