Simulator API

This README provides instructions on how to run the simulator_api.py script and access its deployed URL, Swagger documentation, and endpoints.

Prerequisites

Ensure you have the following installed:

• Python 3.8 or higher
• Required dependencies (install via requirements.txt)

Setup

Install dependencies:

    pip install -r requirements.txt

Running the Simulator

1. Run the script:

   python simulator_api.py
   

2. The API will start, and you can access it at:

   http://127.0.0.1:65433
   

3. For testing and API documentation, refer to:

   http://127.0.0.1:65433/apidocs
   

Accessing the Deployed URL

You can access the API at the provided URL:

Websocket:

http://french.braidpool.net:65433/

Deployed Swagger Documentation

To view the deployed Swagger UI for API documentation, navigate to:

http://french.braidpool.net:65433/apidocs

Endpoints

Refer to the Swagger UI for a detailed list of available endpoints and their usage.

Testing

Run pytest simulator_api_tests.py to run the test suite.

Notes

• Ensure the server is running before accessing the endpoints if running locally.