API Documentation

Documentation related to the API is handled through Swagger docs. These can be accessed by hostinmg the project locally and accessing the docs through the following instructions.

---

Prerequisites

Ensure you have cloned the repository on your local device and run the installation using
make install

---

Usage

Start the development server in the project root by running
make dev

You will then be able to access the Swagger Docs at
http://127.0.0.1:3001/docs.

Sections

The Websockets section is displayed in plain text as these endpoints cannot be tested in the Web UI

The REST API section is displayed in the standard interactable format of Swagger Docs. These endpoints can be tested directly in the browser

---