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

doc: use examples/ring-{malli,spec}-swagger in doc/ring/openapi.md

Browse source
This commit is contained in:
Joel Kaasinen 2023-05-03 17:12:15 +03:00
parent f14808b8a3
commit 253f379fd0
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/ring/openapi.md
View file

@ -5,8 +5,11 @@
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 [http-swagger](../../examples/http-swagger) and The
[ring-malli-swagger](../../examples/ring-malli-swagger) examples also [ring-malli-swagger](../../examples/ring-malli-swagger)
and
[ring-spec-swagger](../../examples/ring-spec-swagger)
examples also
have OpenAPI documentation. have OpenAPI documentation.
## OpenAPI data ## OpenAPI data
@ -51,7 +54,7 @@ that are not generated automatically by reitit.
...}}] ...}}]
``` ```
See [the http-swagger example](../../examples/http-swagger) for a See [the ring-malli-swagger example](../../examples/ring-malli-swagger) for
working examples of `"securitySchemes"` and `"examples"`. working examples of `"securitySchemes"` and `"examples"`.
## OpenAPI spec ## OpenAPI spec