README.md

fastapi-demo

Getting started

The purpose of the project to experiment with async FastAPI framework.

• to create simple crud api
• use SQLAlchemy as BD backend
• find how to manage migrations in SQLAlchemy
• simplify SQLAlchemy ORM usage
• run docker over poetry

What is used?

• poetry for dependency management.
• FastAPI as a web server
• alembic as a db migration tool
• fastapi-sqlalchemy for integration SQLAlchemy into FastAPI
• sqlalchemy_mixins to able use Django-like queries for SQLAlchemy

How to

Create Alembic migrations

alembic init alembic
alembic revision --autogenerate -m "First migration"

Apply migrations

in docker

docker-compose run web alembic upgrade head

locally

alembic upgrade head

Build docker containers

docker-compose run up --build --force-recreate

Run server

in docker

docker-compose run web uvicorn demo:app --host 0.0.0.0 --port 8000 --reload

locally

uvicorn demo:app --reload

Setup Docker on Windows

in PowerShell run:

>> [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
>> Invoke-WebRequest "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-Win
dows-x86_64.exe" -UseBasicParsing -OutFile $Env:ProgramFiles\Docker\docker-compose.exe

Docker notes

Docker Compose wait for container X before starting Y

version: "2.1"

services:
  db:
    image: postgres:latest
    container_name: postgres
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:5433"]
      interval: 30s
      timeout: 5s
      retries: 5
    ...

or

version: "3"

services:
  web:
    build: .
    container_name: fastapi-web
    restart: always
    depends_on:
      - db
    ...

Test API

http://127.0.0.1:8000/docs#

Browse Postgres DB

http://localhost:5050/browser/ use these credentials to login: pgadmin4@pgadmin.org:admin

Useful links:

• FastAPI with SQLAlchemy, PostgreSQL and Alembic and of course Docker
• Developing and Testing an Asynchronous API with FastAPI and Pytest
• Как я SQLAlchemy удобной сделал