api_yamdb

Полное описание.

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

Стек использованных технологий.

python, django, DRF, postman, notion

Как развернуть проект.

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

git clone git@github.com:Master1941/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

примеры запросов и ответов

Импорт из CSV

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

python manage.py import_category_csv

python manage.py import_comments_csv

python manage.py import_title_csv

python manage.py import_genre_csv

python manage.py import_genretitle_csv

python manage.py import_users_csv

python manage.py import_review_csv

Ресурсы API YaMDb:

api/v1/auth/token (POST): передаём логин и пароль, получаем токен.

api/v1/users/me/ (GET, PATCH): пользователь переходит в свой профайл.

api/v1/users/ (GET, POST, PATCH, DELETE): пользователи.

api/v1/titles/ (GET, POST, PATCH): произведения, к которым пишут отзывы.

Пример http-запроса (POST) /titles/

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

Ответ API_YaMDb:

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

api/v1/categories/ (GET, POST, DELETE): категории (типы) произведений (Фильмы, Книги, Музыка).

api/v1/genres/ (GET, POST, DELETE): жанры произведений.

api/v1/reviews/ (GET, POST, PATCH, DELETE): отзывы на произведения.

Пример http-запроса (POST) /reviews/

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

Ответ API_YaMDb:

{
  "id": 0,
  "text": "string",
  "author": "string",
  "score": 1,
  "pub_date": "2019-08-24T14:15:22Z"
}

api/v1/comments/ (GET, POST, PATCH, DELETE): комментарии к отзывам.

При запросе на изменение или удаление данных осуществляется проверка прав доступа.

Список всех запросов к API доступен по ссылке: http://127.0.0.1:8000/redoc/

Над проектом работали:

Дмитрий Цуканов. Управление пользователями: система регистрации и аутентификации, права доступа, работа с токеном, система подтверждения e-mail, поля.

Никита Кузнецов. Категории, жанры и произведения: модели, view и эндпойнты для них.

Александр Буканов. Отзывы и комментарии: модели и view, эндпойнты, права доступа для запросов.