Loading...
Select Version
&pagelevel(3)&pagelevel
The YAML file WebAdmin_REST-API.yaml
represents a formal description of the REST API and can be found in the installed WebAdmin in the Docs
directory, subdirectory REST-API
.
This file was created using the OpenAPI v3 specification.
OpenAPI v3 is a standard for describing RESTful programming interfaces.
It is recommended to import the YAML file into the editor (https://editor.swagger.io/):
"FILE" → "Import file" → "Select YAML file" → "Open".
This website generates attractive documentation from the descriptive description.
Alternatively, SwaggerUI can be used to generate user-friendly documentation, but this involves significant additional effort.
More information: https://github.com/swagger-api/swagger-ui