Open API UI
Introduces the interactive documentation tool for the External API.
Stage | Swagger |
---|---|
QA |
|
PROD |
About the OpenAPI specification
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.
Overview
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.
Authorize
To authorize use the Authorize button and choose one of the available authorization method. With your credentials use the ClientAuth methode.