Skip to content

Commit cd9609a

Browse files
committed
Improve doc
1 parent 18f1d5a commit cd9609a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -657,6 +657,15 @@ Then the server will return a '422' HTTP status code and nice error message:
657657

658658
You can parse this output to make form fields show up with a red border and their appropriate error message.
659659

660+
## OpenAPI 3.0
661+
662+
On the "/openapi" end-point the OpenAPI 3.0 (formerly called "Swagger") specification is served.
663+
It is a machine readable instant documentation of your API. To learn more, check out these links:
664+
665+
- [Swagger Editor](https://editor.swagger.io/) can be used to view and debug the generated specification.
666+
- [OpenAPI specification](https://swagger.io/specification/) is a manual for creating an OpenAPI specification.
667+
- [Swagger Petstore](https://petstore.swagger.io/) is an example documentation that is generated using OpenAPI.
668+
660669
## Cache
661670

662671
There are 4 cache engines that can be configured by the "cacheType" config parameter:

0 commit comments

Comments
 (0)