Authors: Renato Laffranchi Falcão (@renatex333) & Matheus Ribeiro Barros (@MineManiac)
To test the API on your machine, execute the following command in the terminal:
uvicorn sql_app.main:app --reload
Where:
sql_app.main
: refers to themain.py
file located within thesql_app
subdirectory;app
: denotes the object instantiated in themain.py
file with the lineapp = FastAPI()
;--reload
: enables the server to automatically reload upon detecting code changes (development mode only).
To access the API functionalities via a web browser and perform requests through a visual interface, navigate to:
- localhost:8000/docs
A demonstration of the API, developed using Python and the FastAPI framework without database integration, can be viewed here: API Prototype Demo.
The RESTful API has been designed to interface with a MySQL database server, supporting full CRUD operations and providing appropriate responses to user actions. Below is the database schema used for modeling:
A demonstration of the complete RESTful API, developed using Python with FastAPI and integrated with a MySQL database, is available here: Complete API Demo.