API guide

After launching the docker-compose file and after the api container starts. Some of the API documentation can be found by browsing the automatically generated pages that are made using OPENAPI standart.

The API documentation can be found:

  • OAS3 style

    • <Your IP address>:5000/docs
  • Redoc style

    • <Your IP address>:5000/redoc

Using the provided generated API documentation, user can also test requests and see the responses.