fastapi-clean-architecture

description

Base FastAPI project for applying general RestAPI Application cases.

concept

Minimal functionality.
Convincing architecture.
Easy to read.
Compatibility.
Versatility.

base models

user
post [user (1 : n) post]
tag [post (n : n) tag]

integrated with

Python3.9+
Fastapi 0.78.0
Database
1. MySQL5.7+
2. Migration with alembic
3. pytest with real DB
4. Load with two ways (eager, lazy)
5. Modeling with schema (1:1, 1:n, n:n)
dependency-injector
1. service-repository pattern
JWT authentication
1. role separation each endpoint
Deployment
1. container environment(k8s, docker)
2. raw WAS(Web Application Server)

commands

db(alembic)
1. alembic upgrade head: apply every migrations
2. alembic downgrade base: rollback every migrations
3. alembic revision --autogenerate -m "revision_name": create new migration
4. alembic history: get alembic revision history
How to migration
1. Create or modify models from app/model/*.py
2. alembic -x ENV=[dev|stage|prod] revision --autogenerate -m "revision_name"
3. Check auto generated migration file from app/migrations/versions/*.py
4. alembic -x ENV=[dev|stage|prod] upgrade head
  If ENV does not exist, it will be applied to the test.
server
1. uvicorn app.main:app --reload: base
2. options
  1. host: --host 0.0.0.0
  2. port: --port 8000
test
1. pytest: base
2. pytest --cov=app --cov-report=term-missing: coverage with stdout
3. pytest --cov=app --cov-report=html: coverage with html

sample env

# mysql case
ENV=dev
DB=mysql
DB_USER=root
DB_PASSWORD=qwer1234
DB_HOST=localhost
DB_PORT=3306

# postgres case
ENV=dev
DB=postgresql
DB_USER=gyu
DB_PASSWORD=
DB_HOST=localhost
DB_PORT=5432

references

Xenia101/fastapi-clean-architecture

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages