/fastapi-practice

Primary LanguagePython

FastAPI Practice

practice fastapi python web framework on docker environment

Docker Environment

Development

Using Docker Compose File (Recommended)

running containers

$ docker-compose up -d

WARN[0000] Found orphan containers ([fastapi-practice-netshoot-1]) for this project. If you removed or renamed this service in your compose file, you can run this command with the --remove-orphans flag to clean it up. 
[+] Running 4/4
 ⠿ Network fastapi-practice_default                  Created                                                                                                                   0.0s
 ⠿ Container fastapi-practice-my_mysql_test_db-1     Started                                                                                                                   0.4s
 ⠿ Container fastapi-practice-my_mysql_db-1          Healthy                                                                                                                  31.0s
 ⠿ Container fastapi-practice-my_fast_api_web_app-1  Started

removing containers

$ docker-compose down

[+] Running 4/4
 ⠿ Container fastapi-practice-my_fast_api_web_app-1  Removed                                                                                                                   0.0s
 ⠿ Container fastapi-practice-my_mysql_test_db-1     Removed                                                                                                                   0.0s
 ⠿ Container fastapi-practice-my_mysql_db-1          Removed                                                                                                                   0.0s
 ⠿ Network fastapi-practice_default                  Removed                                                                                                                   0.1s

Using Docker Run Command

commands for running develop environment of fastapi on container

FastAPI App Docker Container
docker run \
    -dp 8000:8000 \
    -w /data \
    -v "$(pwd)/app:/data/app" \
    --network=my-mysql-network \
    python:3.10.7 \
    sh -c "pip install --no-cache-dir fastapi alembic uvicorn sqlalchemy mysql-connector-python requests pytest && uvicorn app.main:myApp --host 0.0.0.0 --reload"
MySQL Docker Container
docker run \
    -dp 3306:3306 \
    -v my-mysql-data:/var/lib/mysql \
    --network=my-mysql-network \
    --network-alias=mysql-server \
    -e MYSQL_ROOT_PASSWORD=secret \
    -e MYSQL_DATABASE=todos \
    --platform "linux/amd64" \
    mysql:5.7
MySQL User Creation
mysql> create database my_fast_api_db;
mysql> create user 'my_fast_api_user'@'%' identified by 'fast_api_pwd';
mysql> grant all on my_fast_api_db.* to 'my_fast_api_user'@'%';

Database ORM

SQLAlchemy

  • Installation
pip install SQLAlchemy
  • Tutorials

https://docs.sqlalchemy.org/en/14/tutorial/index.html

  • API Docs

SQLAlchemy Core Docs with API Specification

https://docs.sqlalchemy.org/en/14/core/index.html

SQLAlchemy ORM Docs with API Specification

https://docs.sqlalchemy.org/en/14/orm/index.html

MySql DBAPI

MySQL-Connector

  • Installation
pip install mysql-connector-python
  • Tutorials

https://dev.mysql.com/doc/connector-python/en/

  • Connection String
mysql+mysqlconnector://<user>:<password>@<host>[:<port>]/<dbname>

Migration

Alembic

  • Installation
pip install alembic
  • Tutorials

https://alembic.sqlalchemy.org/en/latest/tutorial.html#the-migration-environment

Test

Pytest

  • Installation
pip install pytest
  • Tutorials

https://docs.pytest.org/en/7.1.x/getting-started.html

  • Run Test
pytest