The generic REST API provides automatically generated API documentation through OpenAPI 3.0.
You can use the API documentation to visualize, test, or generate a client code for the REST API. There are various tools that allow you to use this documentation to provide those capabilities like:
The generic OpenAPI documentation contains descriptions for all endpoints the REST API provides. In particular, it contains API descriptions for the following parts:
User Session API
The Generic OpenAPI Documentation is available in
YAML version of generic documentation.
JSON version of generic documentation.
|It is also available online at https://docs.jmix.io/openapi/1.1/|
Any running Jmix application also automatically generates project-specific documentation. Project-specific means that it contains documentation not only about the standard APIs that part of Jmix, but also about your project-specific entities, like
The project-specific OpenAPI Documentation is available in the formats
YAML version of project-specific OpenAPI documentation.
JSON version of project-specific OpenAPI documentation.