FastAPI Template: Основа

src/fastapi/.dockerignore

@@ -0,0 +1,2 @@
+.venv
+.env

src/fastapi/.env.example

@@ -0,0 +1,10 @@
+db_host=db
+db_port=5432
+db_user=user
+db_password=Qwe123
+db_name=notification_admin
+
+server_host=0.0.0.0
+server_port=8000
+
+jwt_secret_key=v9LctjUWwol4XbvczPiLFMDtZ8aal7mm

src/fastapi/Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.11
+
+WORKDIR /opt/app
+
+ENV PYTHONPATH '/opt/app'
+
+COPY pyproject.toml ./
+RUN pip install poetry \
+    && poetry config virtualenvs.create false \
+    && poetry install --no-dev
+
+COPY bin bin
+COPY lib lib
+COPY entrypoint.sh .
+RUN chmod +x /opt/app/entrypoint.sh

src/fastapi/Makefile

@@ -0,0 +1,3 @@
+include ../../common_makefile.mk
+
+PROJECT_FOLDERS = bin lib tests

src/fastapi/bin/__main__.py

@@ -0,0 +1,17 @@
+import logging
+
+import uvicorn
+
+import lib.app.app as app_module
+from lib.app import settings as libs_app_settings
+
+logger = logging.getLogger(__name__)
+
+
+app_instance = app_module.Application()
+app = app_instance.create_app()
+settings = libs_app_settings.get_settings()
+
+
+if __name__ == "__main__":
+    uvicorn.run(app, host=settings.api.host, port=settings.api.port)

src/fastapi/docker-compose.dev.yml

@@ -0,0 +1,64 @@
+version: '3'
+
+services:
+  db:
+    image: postgres:15.2
+    environment:
+      POSTGRES_USER: ${db_user}
+      POSTGRES_PASSWORD: ${db_password}
+      POSTGRES_DB: ${db_name}
+    env_file:
+      - .env
+    ports:
+      - "${db_port}:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data/
+    restart: always
+    networks:
+      - backend_network
+
+  api:
+    build:
+      context: .
+    container_name: fastapi
+    image: fastapi_app
+    restart: always
+    entrypoint: ["/opt/app/entrypoint.sh"]
+    ports:
+      - "${server_port}:5432"
+    depends_on:
+      - db
+    env_file:
+      - .env
+    networks:
+      - backend_network
+      - api_network
+
+  nginx:
+    image: nginx:1.23.4
+    volumes:
+      - ./nginx:/etc/nginx/:ro
+    depends_on:
+      - api
+    ports:
+      - "80:80"
+    networks:
+      - api_network
+
+  redis:
+    image: redis:7.0.11
+    restart: always
+    command: redis-server --bind 0.0.0.0
+    ports:
+      - "6379:6379"
+    networks:
+      - backend_network
+
+volumes:
+  postgres_data:
+
+networks:
+  api_network:
+    driver: bridge
+  backend_network:
+    driver: bridge

src/fastapi/docker-compose.yml

@@ -0,0 +1,60 @@
+version: '3'
+
+services:
+  db:
+    image: postgres:15.2
+    environment:
+      POSTGRES_USER: ${db_user}
+      POSTGRES_PASSWORD: ${db_password}
+      POSTGRES_DB: ${db_name}
+    env_file:
+      - .env
+    ports:
+      - "127.0.0.1:${db_port}:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data/
+    restart: always
+    networks:
+      - backend_network
+
+  api:
+    build:
+      context: .
+    container_name: fastapi
+    image: fastapi_app
+    restart: always
+    entrypoint: ["/opt/app/entrypoint.sh"]
+    depends_on:
+      - db
+    env_file:
+      - .env
+    networks:
+      - backend_network
+      - api_network
+
+  nginx:
+    image: nginx:1.23.4
+    volumes:
+      - ./nginx:/etc/nginx/:ro
+    depends_on:
+      - api
+    ports:
+      - "80:80"
+    networks:
+      - api_network
+
+  redis:
+    image: redis:7.0.11
+    restart: always
+    command: redis-server --bind 0.0.0.0
+    networks:
+      - backend_network
+
+volumes:
+  postgres_data:
+
+networks:
+  api_network:
+    driver: bridge
+  backend_network:
+    driver: bridge

src/fastapi/entrypoint.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+while ! (echo > /dev/tcp/db/5432) >/dev/null 2>&1; do
+  sleep 1
+done
+
+exec python -m bin

src/fastapi/lib/api/models/mixins.py

@@ -0,0 +1,26 @@
+import uuid
+
+import sqlalchemy
+from sqlalchemy import Column, DateTime
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.ext.declarative import declared_attr
+
+
+class BaseMixin:
+    @declared_attr
+    def id(cls):
+        return Column(
+            UUID(as_uuid=True),
+            primary_key=True,
+            default=uuid.uuid4,
+            unique=True,
+            nullable=False,
+        )
+
+    @declared_attr
+    def created_at(cls):
+        return Column(DateTime, server_default=sqlalchemy.func.now())
+
+    @declared_attr
+    def updated_at(cls):
+        return Column(DateTime, server_default=sqlalchemy.func.now())

src/fastapi/lib/api/schemas/entity.py

@@ -0,0 +1,8 @@
+import uuid
+
+import pydantic
+
+
+class Token(pydantic.BaseModel):
+    sub: uuid.UUID
+    exp: int | None = None

src/fastapi/lib/api/services/token.py

@@ -0,0 +1,27 @@
+from jose import JWTError, jwt
+from pydantic import ValidationError
+
+from fastapi import FastAPI, HTTPException, Security, status
+from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
+from lib.api.schemas.entity import Token
+from lib.app import settings as lib_app_settings
+
+app = FastAPI()
+settings = lib_app_settings.get_settings()
+
+security = HTTPBearer()
+
+
+def get_token_data(
+    authorization: HTTPAuthorizationCredentials = Security(security),
+) -> Token:
+    token = authorization.credentials
+    try:
+        secret_key = settings.jwt_secret_key
+        payload = jwt.decode(token, secret_key, algorithms=["HS256"])
+        return Token(**payload)
+    except (JWTError, ValidationError):
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Could not validate credentials",
+        )

src/fastapi/lib/app/app.py

@@ -0,0 +1,40 @@
+import logging
+import logging.config as logging_config
+
+import fastapi
+import lib.api.handlers as admin_api_handlers
+
+from .logger import LOGGING
+from .settings import get_settings
+
+logging_config.dictConfig(LOGGING)
+logger = logging.getLogger(__name__)
+
+
+class Application:
+    def __init__(self) -> None:
+        self.settings = get_settings()
+        self.logger = logging.getLogger(__name__)
+        self.producer = None
+
+    def create_app(self) -> fastapi.FastAPI:
+        app = fastapi.FastAPI(
+            title="FastAPI",
+            version="0.1.0",
+            docs_url="/api/openapi",
+            openapi_url="/api/openapi.json",
+            default_response_class=fastapi.responses.ORJSONResponse,
+        )
+
+        # app.include_router(admin_api_handlers.user_router, prefix="/api/v1/users", tags=["users"])
+        # app.include_router(admin_api_handlers.movie_router, prefix="/api/v1/movies", tags=["movies"])
+
+        @app.on_event("startup")
+        async def startup_event():
+            self.logger.info("Starting server")
+
+        @app.on_event("shutdown")
+        async def shutdown_event():
+            self.logger.info("Shutting down server")
+
+        return app

src/fastapi/lib/app/logger.py

@@ -0,0 +1,69 @@
+import pydantic_settings
+
+
+class LoggingSettings(pydantic_settings.BaseSettings):
+    log_format: str = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    log_default_handlers: list[str] = [
+        "console",
+    ]
+
+    log_level_handlers: str = "DEBUG"
+    log_level_loggers: str = "INFO"
+    log_level_root: str = "INFO"
+
+
+log_settings = LoggingSettings()
+
+
+LOGGING = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {
+        "verbose": {"format": log_settings.log_format},
+        "default": {
+            "()": "uvicorn.logging.DefaultFormatter",
+            "fmt": "%(levelprefix)s %(message)s",
+            "use_colors": None,
+        },
+        "access": {
+            "()": "uvicorn.logging.AccessFormatter",
+            "fmt": "%(levelprefix)s %(client_addr)s - '%(request_line)s' %(status_code)s",
+        },
+    },
+    "handlers": {
+        "console": {
+            "level": log_settings.log_level_handlers,
+            "class": "logging.StreamHandler",
+            "formatter": "verbose",
+        },
+        "default": {
+            "formatter": "default",
+            "class": "logging.StreamHandler",
+            "stream": "ext://sys.stdout",
+        },
+        "access": {
+            "formatter": "access",
+            "class": "logging.StreamHandler",
+            "stream": "ext://sys.stdout",
+        },
+    },
+    "loggers": {
+        "": {
+            "handlers": log_settings.log_default_handlers,
+            "level": log_settings.log_level_loggers,
+        },
+        "uvicorn.error": {
+            "level": log_settings.log_level_loggers,
+        },
+        "uvicorn.access": {
+            "handlers": ["access"],
+            "level": log_settings.log_level_loggers,
+            "propagate": False,
+        },
+    },
+    "root": {
+        "level": log_settings.log_level_root,
+        "formatter": "verbose",
+        "handlers": log_settings.log_default_handlers,
+    },
+}

src/fastapi/lib/app/settings.py

@@ -0,0 +1,36 @@
+import functools
+
+import pydantic_settings
+from dotenv import load_dotenv
+from pydantic import Field
+
+load_dotenv(".env.dev")
+
+
+class DbSettings(pydantic_settings.BaseSettings):
+    model_config = pydantic_settings.SettingsConfigDict(env_prefix="db_")
+
+    host: str = "localhost"
+    port: int = 5432
+    user: str
+    password: str
+    name: str
+
+
+class ApiSettings(pydantic_settings.BaseSettings):
+    model_config = pydantic_settings.SettingsConfigDict(env_prefix="server_")
+
+    host: str = "0.0.0.0"
+    port: int = 8000
+
+
+class Settings(pydantic_settings.BaseSettings):
+    db: DbSettings = Field(default_factory=DbSettings)
+    api: ApiSettings = Field(default_factory=ApiSettings)
+
+    jwt_secret_key: str
+
+
+@functools.lru_cache
+def get_settings() -> Settings:
+    return Settings()