API Documentation
The generic REST API provides automatically generated API documentation through Swagger 2.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:
Generic Swagger Documentation
The generic Swagger documentation contains descriptions for all endpoints the REST API provides. In particular, it contains API descriptions for the following parts:
-
Authentication
-
Entities API
-
Files API
-
Messages API
-
User Session API
The Generic Swagger Documentation is available in JSON
and YAML
formats:
/docs/swagger.yaml
-
YAML version of generic documentation.
/docs/swagger.json
-
JSON version of generic documentation.
It is also available online at http://files.cuba-platform.com/swagger/7.2 |
Project-specific Swagger Documentation
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 sample_Customer
, sample_Order
, etc.
The project-specific Swagger Documentation is available in the formats JSON
and YAML
:
/docs/swaggerDetailed.yaml
-
YAML version of project-specific Swagger documentation.
/docs/swaggerDetailed.json
-
JSON version of project-specific Swagger documentation.