Desert and Recepies

Desert and Recepies - backend-сервис на основе FastAPI, предлагающий пользователям возможномть хранить рецепты любимых сладостей и обмениваться ими с другими пользователями. Также сервис позволяет искать и заказвать десерты. Авторизация - JWT. База данных - PostgreSQL. Миграции - Alembic. ORM - SQLAlchemy v.1.4. Валидация - Pydantic. Зависимости - Poetry.

Описание схемы БД

База данных содержит 6 моделей: Пользователь, Токен, Рецепт, Десерт, Заказ, Строчка заказа. Ниже представлена графическая схема моделей и их взаимосвязей.

Краткая документация API

Работа с моделями БД осуществляется по следующим эндпоинтам:

Method	HTTP request	Description
[create_new_user]	POST /sign-up	Регистрация нового пользователя
[get_user_by_email]	POST /auth	Авторизация пользователя.
[get_current_user]	GET /users/me	Извлечение текущего пользователя.
[create_recipe]	POST /recipes	Добавление нового рецепта.
[read_my_recipes]	GET /my_recipes	Извлечение рецептов текущего пользователя.
[read_recipe_by_id]	GET /recipes/{recipe_id}	Извлечение рецепта по ID.
[update_recipe_by_id]	PUT /recipes/{recipe_id}	Редактирование рецепта пользователя по ID.
[read_deserts]	GET /deserts/	Извлечение списка всех десертов.
[create_desert]	POST /deserts/	Добавление нового десерта.
[read_desert_by_id]	GET /deserts/{desert_id}	Извлечение десерта по ID.
[update_desert_by_id]	PUT /deserts/{desert_id}	Редактирование десерта пользователя по ID.
[create_order]	POST /my_orders/	Создание заказа.
[read_my orders]	GET /my_orders/	Извлечение списка всех заказов текущего пользователя.
[read_order_by_id]	GET /my_orders/{order_id}	Извлечение заказа по ID.
[add_desert_to order]	POST /my_orders/	Добавление десерта в заказ.

Исчерпывающую информацию по работе API можно получить после запуска по адресу http://127.0.0.1:8000/ Документация на основе Swagger, в соответствии со стандартом OpenAPI.

Инструкция по установке

1. Подготовка базы данных

1.1 Обновляете систему, уставливаете и запускаете Postgres

sudo apt update
sudo apt install postgresql-14

1.2 Заходите в аккаунт Postgres, открываете терминал Postgres, уставливаете и запускаете Postgres

sudo -i -u postgres 

psql

1.3 Создаете базу данных, подключаетесь и устанавливаете расширение для полнотекстового поиска (pg_trgm)

CREATE DATABASE <DB_NAME>;

2. Запуск проекта

2.1 Клонируете репозиторий

git clone https://github.com/XanderMoroz/recepies_restapi.git

2.2 Устанавливаете, виртуальное окружение:

poetry shell

2.3 Устанавливаете зависимости проекта:

poetry install

2.4 Создаете файл .env и заполняете его по примеру файла .env.template

2.5 Применяете миграции в базе данных

alembic upgrade head

2.6 Запускаете проект:

uvicorn app.main:app --reload

2.7 Документация доступна по адресу:

http://127.0.0.1:8000/