Skip to content

Групповой проект. API для платформы Yamdb - собирающей отзывы на различные темы (книги, фильмы и др).

MrBrus/API-Yamdb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Описание проекта YaMDb:

  1. Проект YaMDb собирает отзывы (Review) пользователей на произведения (Titles).
  2. Категории (Category) произведений могут быть следующими: «Книги», «Фильмы», «Музыка». Список категорий может быть расширен администратором.
  3. Произведению может быть присвоен жанр (Genre) из списка предустановленных. Новые жанры может создавать только администратор.
  4. Пользователи оставляют к произведениям текстовые отзывы (Review) и ставят произведению оценку в диапазоне от одного до десяти (целое число); из пользовательских оценок формируется усреднённая оценка произведения — рейтинг (целое число). На одно произведение пользователь может оставить только один отзыв.

Полный список эндпойнтов, методы и параметры запросов описаны в докуметации, которая будет доступна после установки проекта:

127.0.0.1:8000/redoc/ 

Пример использования API

GET /titles/ - получить список всех произведений
Ответ (200):

Ключ Значение Описание
"id" number ID произведения
"name" "string" Название
"year" number Год выпуска
"rating" number Рейтинг на основе отзывов
"description" "string" Описание
"genre" Array of objects Жанр
"name" Название жанра
"slug" Поле "slug"
"category" objects Категория
"name" Название категории объекта
"slug" Поле "slug"

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

  • Python 3.8
  • Django 3.2
  • Django Rest Framework
  • Simple-JWT

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

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

git clone https://github.com/Sprngtm4htlr/api_yamdb

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

python -m venv venv

source venv/Scripts/activate

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

python -m pip install --upgrade pip

pip install -r requirements.txt

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

python3 manage.py migrate

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

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

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

artem123dd - отзывы (Review) и комментарии (Comments): модели и view, эндпойнты, права доступа для запросов. Рейтинги произведений.

About

Групповой проект. API для платформы Yamdb - собирающей отзывы на различные темы (книги, фильмы и др).

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published