https://github.com/likeinlife/video_api

API-сервис для получения данных с сайта FarPost
https://github.com/likeinlife/video_api

clean-architecture ddd docker fastapi poetry postgresql pydantic python3

Last synced: 3 months ago
JSON representation

API-сервис для получения данных с сайта FarPost

• Host: GitHub
• URL: https://github.com/likeinlife/video_api
• Owner: likeinlife
• Created: 2024-06-06T13:33:10.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-06T20:49:22.000Z (about 2 years ago)
• Last Synced: 2024-06-07T19:36:59.338Z (about 2 years ago)
• Topics: clean-architecture, ddd, docker, fastapi, poetry, postgresql, pydantic, python3
• Language: Python
• Homepage:
• Size: 257 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Описание

API-сервис для получения данных с сайта FarPost

# Настройка

1. Необходимо скопировать sample.env в docker-compose/.env. Для этого выполните команду `make env`

# Запуск

1. `make storages` - запустить PostgreSQL

2. `make app` - запустить приложение

3. `make down-all` - закрыть

# Проверка работоспособности

При следовании инструкции, на локальном хосте должен открыться порт 8000.

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

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

Реализованы юнит- и интеграционные тесты

Запуск - `make tests`

Удаление артефактов - `make down-tests`

# Реализованные дополнительные требования

1. Приложение построено, следуя принципам слоистой архитектуры

2. Использовалась ORM SQLALchemy

3. Добавлена регистрация, аутентификация, авторизация пользователей, используя сессии

# Стек

1. Python3.11

2. FastAPI

3. SQLAlchemy

4. Docker

5. PostgreSQL

6. alembic

7. pydantic, pydantic-settings

8. poetry

9. dishka

10. structlog

# Скриншоты

![](./images/swagger.png)

![](./images/detail_response.png)

![](./images/list_response_p1.png)

![](./images/list_response_p2.png)

![](./images/wrong_password_or_login.png)