Swagger API

Locally, Swagger Documentation for our Back-End API's is available at http://localhost:8080/api/v1/docs (opens in a new tab)

On hosted services, it will be located at http://hosted-service-url/api/v1/docs (opens in a new tab)

The documentation is automatically generated from the code, and is always up to date. It is also interactive, and allows you to test the API's directly from the documentation.

To test the API's you can select the desired API call and press the "Try it out" button. This will allow you to enter the required parameters for the API call, and then execute it. The response will be displayed below the API call.