YaMDb

Описание

Учебный проект Яндекс Практикум.

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

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

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

Добавлять произведения, категории и жанры может только администратор.

Благодарные или возмущённые пользователи оставляют к произведениям текстовые отзывы и ставят произведению оценку в диапазоне от одного до десяти (целое число); из пользовательских оценок формируется усреднённая оценка произведения — рейтинг (целое число). На одно произведение пользователь может оставить только один отзыв.

Пользователи могут оставлять комментарии к отзывам.

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

Технологии

Python 3.9 Django 3.2 DRF JWT Клонировать репозиторий и перейти в него в командной строке:

git clone git@github.com:AlexBatanov/api_yamdb.git

cd api_yamdb

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

python3 -m venv env

source env/bin/activate

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

python3 -m pip install --upgrade pip

pip install -r requirements.txt

Выполнить миграции:

python3 manage.py migrate

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

python3 manage.py runserver

Открыть документацию:

http://127.0.0.1:8000/redoc/

Регистрация:

POST http://127.0.0.1:8000/api/v1/auth/signup/

тело запроса:

{
    "email": "user@example.com",
    "username": "string"
}

после запроса на указанную почту придет ключ, для получения токена

Получение JWT-токена

http://127.0.0.1:8000/api/v1/auth/token/

тело запроса:

{
    "username": "string",
    "confirmation_code": "string"
}

Другие примеры запросов:

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

GET http://127.0.0.1:8000/api/v1/titles/

вернет ответ в формате JSON:

{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "id": 0,
      "name": "string",
      "year": 0,
      "rating": 0,
      "description": "string",
      "genre": [
        {
          "name": "string",
          "slug": "string"
        }
      ],
      "category": {
        "name": "string",
        "slug": "string"
      }
    }
  ]
}

Частичное обновление информации о произведении:

PATCH http://127.0.0.1:8000/api/v1/titles/{titles_id}/

тело запроса:

{
  "name": "string",
  "year": 0,
  "description": "string",
  "genre": [
    "string"
  ],
  "category": "string"
}

Добавление нового отзыва:

POST http://127.0.0.1:8000/api/v1/titles/{title_id}/reviews/

тело запроса:

{
    "text": "string",
    "score": 1
}

Частичное обновление отзыва по id:

PUTCH http://127.0.0.1:8000/api/v1/titles/{title_id}/reviews/{review_id}/

тело запроса:

{
  "text": "string",
  "score": 1
}

Авторы

Студенты Яндекс Практикум программы Python-разработчик плюс, когорта 19+

Александр Батанов в роли тимлида
Константин Гашев в роли разработчика
Олег Исаев в роли разработчика