Cервис Marketplace

Описание

API онлайн-магазина бытовой техники.

Доступный функционал

• Регистрация пользователей с помощью библиотеки fastapi-users.
• Аутентификация реализована с помощью куков и JWT-токена.
• У неаутентифицированных пользователей доступ к API только на уровне чтения.
• Создание объектов разрешено только аутентифицированным пользователям.
• Возможность получения подробной информации о себе.
• Загрузка тестовых данных в БД.
• Возможность осуществить операции CRUD для категорий.
• Возможность получить список всех товаров подкатегории и выполнить операции CRUD.
• Возможность получить подробную информацию о товаре и выполнить операции CRUD.
• Отправка email с подтверждением покупки пользователя посредством Celery.
• Возможность администрирования сервиса.
• Версионирование API.
• Кеширование/брокер задач с помощью Redis.
• Логирование посредством кастомного логгера.
• Мониторинг ошибок с помощью Sentry.
• Сбор метрик с помощью Prometheus.
• Визуализация метрик посредством Grafana.
• Возможность развернуть проект в Docker-контейнерах.

Локально документация доступна по адресу: http://localhost:8000/v1/docs/

В контейнерах Docker документация доступна по адресу: http://localhost:7777/v1/docs/

Технологии

• Python 3.9
• FastAPI
• fastapi-cache2
• Асинхронность
• Cookies
• JWT
• Alembic
• SQLAlchemy
• Docker
• PostgreSQL
• Asyncpg
• CORS
• Redis
• Celery
• Flower
• Sentry
• Prometheus
• Grafana
• Uvicorn
• Gunicorn

Локальный запуск проекта

• Предварительно необходимо установить Docker и Redis для вашей системы.

• Склонировать репозиторий:

    git clone <название репозитория>

Cоздать и активировать виртуальное окружение:

Команды для установки виртуального окружения на Mac или Linux:

    python3 -m venv env
    source env/bin/activate

Команды для Windows:

    python -m venv venv
    source venv/Scripts/activate

• Перейти в директорию app:

    cd /app

• Создать файл .env по образцу:

    cp .env-local-example .env

• Установить зависимости из файла requirements.txt:

    cd ..
    pip install -r requirements.txt

• Для создания миграций выполнить команду:

    alembic init migrations

• В папку migrations в env файл вставьте следующий код:

from logging.config import fileConfig

from alembic import context
from sqlalchemy import engine_from_config, pool

from app.categories.models import Category
from app.config import settings
from app.database.db import Base
from app.goods.models import Goods
from app.purchases.models import Purchase
from app.subcategories.models import Subcategory
from app.users.models import User

config = context.config

config.set_main_option('sqlalchemy.url', f'{settings.DATABASE_URL}?async_fallback=True')

if config.config_file_name is not None:
    fileConfig(config.config_file_name)

target_metadata = Base.metadata

• Инициализировать БД:

    alembic revision --autogenerate -m "comment"   

• Применить миграцию:

    alembic upgrade head 

• Запустить проект:

    uvicorn app.main:app --reload    

• Запустить Redis:

    redis-server.exe 
    redis-cli.exe  

• Запустить Celery:

    celery -A app.tasks.celery:celery worker --loglevel=INFO --pool=solo

• Запустить Flower:

    celery -A app.tasks.tasks:celery flower

Запуск в контейнерах Docker

• Находясь в главной директории проекта:

• Создать файл .env-docker по образцу:

   cp .env-docker-example .env-docker 

• Запустить проект:

    docker-compose up -d --build  

Примеры некоторых запросов API

Регистрация пользователя:

   POST /users/register

Получение данных своей учетной записи:

   GET /users/me 

Добавление покупки:

   POST /purchases

Получение списка категорий:

   GET /categories 

Получение списка всех товаров подкатегории:

   GET /subcategories/{subcategory_id}/goods

Загрузка тестовых данных:

   POST /import/{table_name}

Полный список запросов API находится в документации

Автор

Гут Владимир - https://github.com/VladimirMonolith