Project specific Swagger Documentation - cuba-platform/restapi GitHub Wiki
The generic documentation on the REST API is available at http://files.cuba-platform.com/swagger/7.0.
Any running CUBA application also exports the project-specific documentation generated according to the Swagger specification version 2.0.
The documentation is available at the following URLs:
/rest/v2/docs/swagger.yaml- YAML version of generic documentation./rest/v2/docs/swagger.json- JSON version of generic documentation./rest/v2/docs/swaggerDetailed.yaml- YAML version of project-specific Swagger documentation./rest/v2/docs/swaggerDetailed.json- JSON version of project-specific Swagger documentation.
For example:
http://localhost:8080/app/rest/v2/docs/swagger.yaml
http://localhost:8080/app/rest/v2/docs/swaggerDetailed.yaml
The documentation can be used to visualize, test or generate a client code for the REST API. See the following tools: Swagger UI, Swagger Inspector, Postman, Swagger Codegen.
The generated documentation includes:
- CRUD operations, such as:
- entity CRUD operations:
- Getting an Entity Instances List,
- filtering entities.
All CRUD parameters and responses have a model available, for example:
- Predefined REST queries:
- Exposed services:
