Swagger UI

Swagger UI is a tool that allows developers to interact with, test, and get code snippets for APIs.

The backend system uses Swagger UI to help developers (especially frontend developers) interact with and quickly understand the API endpoints provided by the backend.

Accessing Swagger UI

Open the system using docker as described in the Docker Setup page. Then, navigate to: http://localhost:8000/docs in your web browser.

The Swagger UI will display all the available API endpoints, their methods (GET, POST, etc.), required parameters, and response formats. Moreover, it provides an interactive interface where you can test the endpoints directly from the browser. It will also generate code snippets to help you integrate the API into your applications.