Проект YaMDb собирает отзывы пользователей на различные произведения.

1. Описание
2. Стек технологий
3. Как запустить проект
4. Документация по api
5. Примеры запросов к api
6. Авторы проекта

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

• проект написан на Python с использованием Django REST Framework
• библиотека Simple JWT - работа с JWT-токеном
• библиотека django-filter - фильтрация запросов
• базы данны - SQLite3
• система контроля версий - git

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

git clone [email protected]:mvolodka/api_yamdb.git
cd api_yamdb

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

python -m venv venv
source venv/bin/activate

• Обновить установщик пакетов и установить зависимости из файла requirements.txt:

python -m pip install --upgrade pip
pip install -r requirements.txt

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

python manage.py migrate
(python manage.py migrate --run-syncdb)

• Наполнить базу тестовыми данными:

python manage.py import_csv_to_db

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

python3 manage.py runserver

Ознакомиться с документацией по адресу. http://127.0.0.1:8000/redoc/

в теле передать JSON { "username": "имя_пользователя", "email": "адрес эл. почты" } POST-запрос на эндпоинт:

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

в папке sent_emails найти письмо и скопировать полученный код подтверждения.

в теле передать JSON { "username": "имя_пользователя", "confirmation_code": "код_подтвержения" } POST-запрос на эндпоинт:

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

Токен использовать для авторизации

Доступные энд-поинты: GET-запросы

/api/v1/users/

/api/v1/titles/

/api/v1/categories/

/api/v1/genres/

/api/v1/titles/{title_id}/reviews/

/api/v1/titles/{title_id}/reviews/{review_id}/comments/

Мария Константинова, python-developer Александр Скрынник, python-developer Владимир Михейкин, python-developer

© 2023, Contributors on git