likeinlife / memes

АПИ для загрузки/получения/редактирования мемов.

Description

АПИ для загрузки/получения/редактирования мемов.

Мем состоит из текста и картинки.

Картинки сохраняются в S3 хранилище.

Диаграмма

Запуск

1. make dev-storages - запустить PostgreSQL, MinIO
2. make dev-app - запустить приложения
3. make down-all - закрыть приложения
4. make down-storages-v - удалить volume хранилищ

Swagger

Swagger доступен по адресу http://localhost:8000/api/docs

Тестирование

1. cd memes/public - перейти в тестируемую директорию
2. poetry install --with test - установить зависимости для тестирования
3. pytest - запустить тесты

Описание работы

Проект представляет собой два сервиса: PublicAPI и Gateway.

• PublicAPI - публичное апи для действий с мемами.
• Gateway - закрытое апи для взаимодействия с S3 хранилищем.

Приложения построены с оглядкой на чистую архитектуру.

В каждом выделены слои:

• domain - домен
• logic - бизнес-логика: use-cases, interactors (в Gateway отсутствует, т.к. нет необходимости)
• infra - репозитории, сервисы
• presentation - представление

В качестве DI-библиотеки применяется Dishka. Конфигурация описана в каждом проекте в пакете container

Время работы

Полное время работы над проектом составило 8 часов.

Стек

• Python3.11
• FastAPI
• MinIO
• PostgreSQL
• Docker
• SQLALchemy
• alembic
• dishka
• pytest

Скриншоты

Скриншоты Swagger можно посмотреть в папке ./static/