Skip to content

Oorzhakau/api_yamdb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Проект API YaMDb 🔍

api_yamdb


REST API для сервиса YaMDb — базы отзывов на произведения (фильмов, картин музыки и других сущностей).

Проект YaMDb собирает отзывы (Review) пользователей на произведения (Titles). Произведения делятся на категории: «Книги», «Фильмы», «Музыка». Список категорий (Category) может быть расширен.

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

В каждой категории есть произведения: книги, фильмы или музыка. Например, в категории «Книги» могут быть произведения «Винни Пух и все-все-все» и «Марсианские хроники», а в категории «Музыка» — песня «Давеча» группы «Насекомые» и вторая сюита Баха.

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

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

Установка:

  1. Клонируйте репозиторий на локальную машину. git clone https://github.com/Vladislavhgtech/api_yamdb.git
  2. Установите виртуальное окружение. python -m venv venv
  3. Активируйте виртуальное окружение. source venv\Scripts\activate
  4. Установите зависимости. pip install -r requirements.txt
  5. Запустите локальный сервер. python manage.py runserver

Техническое описание проекта YaMDb

К проекту по адресу http://127.0.0.1:8000/redoc/ подключена документация API YaMDb. В ней описаны возможные запросы к API и структура ожидаемых ответов. Для каждого запроса указаны уровни прав доступа: пользовательские роли, которым разрешён запрос.

Список исполнителей:

Александр Ооржак. Управление пользователями (Auth и Users): система регистрации и аутентификации, права доступа, работа с токеном, система подтверждения e-mail, поля.

Владислав Московский. Категории (Categories), жанры (Genres) и произведения (Titles): модели, view и эндпойнты для них.

Сайф Холов. Permissions, исправление багов, тестирование, ответы на вопросы Ревью

Releases

No releases published

Packages

No packages published