Skip to content

Latest commit

 

History

History
83 lines (63 loc) · 4.7 KB

README.md

File metadata and controls

83 lines (63 loc) · 4.7 KB
Raw

Проект API_YaMDb

Описание

Проект YaMDb собирает отзывы (Review) пользователей на произведения (Title). Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку.

Произведения делятся на категории, такие как «Книги», «Фильмы», «Музыка». Например, в категории «Книги» могут быть произведения «Винни-Пух и все-все-все» и «Марсианские хроники», а в категории «Музыка» — песня «Давеча» группы «Жуки» и вторая сюита Баха. Список категорий (Category) может быть расширен (например, можно добавить категорию «Изобразительное искусство» или «Ювелирка»).

Произведению может быть присвоен жанр из списка предустановленных (например, «Сказка», «Рок» или «Артхаус»). Новые жанры может создавать только администратор.

Благодарные или возмущённые читатели оставляют к произведениям текстовые отзывы (Review) и выставляют произведению рейтинг (оценку в диапазоне от одного до десяти). Из множества оценок автоматически высчитывается средняя оценка произведения.

Полная документация к API находится по эндпоинту/redoc.

Технологии:

  • Python 3.9.,
  • Django 3.2.,
  • DRF,
  • JWT,
  • SQLite

Как запустить проект:

1. Клонировать репозиторий и перейти в него в командной строке:

git clone git@github.com:Olga-Ustinova/api_yamdb.git

cd api_yamdb

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

python -m venv venv

source venv/Scripts/activate

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

python -m pip install --upgrade pip

pip install -r requirements.txt

4. Перейти в директорию api_yamdb и выполнить миграции:

cd api_yamdb

python manage.py makemigrations

python manage.py migrate

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

python manage.py runserver

Примеры работы с API

Для неавторизированных пользователей работа с API доступна только в режиме чтения.

Алгоритм регистрации пользователей:

  1. Пользователь отправляет POST-запрос на добавление нового пользователя с параметрами email и username на эндпоинт /api/v1/auth/signup/. Использовать имя 'me' в качестве username запрещено. Поля email и username должны быть уникальными (например, передав в Body в Postman):
{
    "username": "string", 
    "email": "string" 
}
  1. YaMDB отправляет письмо с кодом подтверждения (confirmation_code) на адрес email.
  2. Пользователь отправляет POST-запрос с параметрами username и confirmation_code на эндпоинт /api/v1/auth/token/, в ответе на запрос ему приходит token (JWT-токен) (например, передав в Body в Postman):
{
    "username": "string", 
    "confirmation_code": "string" 
}
  1. При желании пользователь отправляет PATCH-запрос на эндпоинт /api/v1/users/me/ и заполняет поля в своём профайле (описание полей — в документации).

Команда разработчиков: