Using the Swagger Docs page

How the Swagger Docs page can be used to quickly test the APIs

Assuming that you have been able to successfully start the Docker and access the Swagger Docs page via:

http://localhost:7777/docs

The following describes how to use the Swagger Docs page. The Swagger Docs page makes http(s) calls via your browser. Hence, everything detailed below can also be accomplished using an http library in a programming language of your choice.

The page also provides cURL commands that you can execute from the command line to send requests and receive responses.

Authorization

Each API end-point in the Swagger Docs page requires an x-api-key header for authorisation.

For your convenience, the Swagger Docs page allows you to authorise via the UI in a browser.

This is demonstrated in the next section.