Skip to content
/ QuickStartAPI Public template

QuickStartAPI — проект на FastAPI для быстрого старта разработки с готовыми настройками для масштабируемости и удобного развёртывания через Docker.

Notifications You must be signed in to change notification settings

mswesson/QuickStartAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 

Repository files navigation

QuickStartAPI 🚀

Готовое решение на FastAPI для быстрого старта разработки веб-сервисов. Проект построен на модульной архитектуре, что упрощает масштабирование и сопровождение кода. Всё настроено для удобной локальной разработки и запуска в продакшене через Docker.

Возможности

  • Аутентификация и авторизация через JWT
  • Работа с базой данных с помощью SQLAlchemy и Alembic
  • Валидация входящих и исходящих данных через Pydantic
  • Централизованная обработка ошибок
  • Отправка email-сообщений (например, для подтверждения регистрации)
  • Очередь фоновых задач на Celery + Redis (например отправка почты)
  • Чистая модульная архитектура
  • Поддержка Docker и Docker Compose
  • Автоматическая документация API (Swagger / ReDoc)
  • Гибкая настройка всего в конфигурационном файле .env

Архитектура

QuickStartAPI/
│
├── api/                    # Основной модуль API
│    ├── alembic/            # Миграции
│    ├── authorization/      # Конфиг авторизации
│    ├── database/           # Подключение, модели и отправка запросов в БД
│    ├── exceptions/         # Обработчики ошибок, классы ошибок
│    ├── redis_client/       # Конфиг redis
│    ├── routers/            # Роутеры API
│    ├── schemes/            # Pydantic схемы
│    ├── services/           # Сервисы с логикой
│    ├── alembic.ini         # Конфигурация alembic
│    ├── config.py           # Настройки проекта, подгрузка переменных окружения
│    ├── Dockerfile          # Докерфайл API
│    ├── main.py             # Инициализация проекта (точка входа)
│    └── requirements.txt    # Зависимости API
├── .env.templates          # Шаблон переменных окружения
├── .gitignore              # Файлы и папки, игнорируемые Git
├── compose.yaml            # Конфигурация Docker Compose
├── README.MD               # Описание проекта

Запуск

  1. Установите докер с оффициального сайта
  2. Запустите сборку контейнера docker compose build
  3. Запустите проект docker compose up

About

QuickStartAPI — проект на FastAPI для быстрого старта разработки с готовыми настройками для масштабируемости и удобного развёртывания через Docker.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published