Open API UI

The OpenAPI specification defines a standard, language-agnostic interface to RESTful APIs. OpenAPI definition files are written in the YAML format, which is automatically rendered by the Swagger Ui into a more human-readable interface.

The Swagger UI allows API testing directly via the browser. Add to the root url of the API '/swagger/index.html' to open the Swagger UI website. The available endpoints are documented with the OpenAPI spec.

To authorize use the Authorize button and choose one of the available authorization method. With your credentials use the ClientAuth methode.

When you expand an endpoint, you see a description, the input parameters (if required), an example server respond and the possible return states.

To test an endpoint select Autohorize from the Swagger UI page and authorize with your credentials. Then choose an endpiont and expand it. Select Try it out on the endpoint definition page. Input the parameters or the body as required, then select Execute