Example API design

Simple FastAPI application with connection to MySQL database.

Quickstart

Create environment:

python -m venv myenv
source myenv/bin/activate

Install dependencies:

pip install -r requirements.txt

Run MySQL database:

docker run -dp 3306:3306 -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=school mysql:9.0.1

Run application:

uvicorn project.main:app --app-dir src --reload

Behaviour tested with Python version 3.12.9, API documentation can be accessed at http://127.0.0.1:8000/docs.

Implemented endpoints:

• /create/teacher
• /create/student
• /yearbook/{teacher_id}

Configuration

Connection to database can be configured by following environment variables:

DATABASE_HOST        The hostname or IP to use for the connection
DATABASE_NAME        The name of the database to connect to
DATABASE_PASSWORD    The password of the database user
DATABASE_PORT        The port number to use for the connection
DATABASE_USER        The username to use for the connection

or directly modifying config.py module.