Skip to content

Проект, позволяющий собирать отзывы на различные произведения от разных пользователей

Notifications You must be signed in to change notification settings

daniil-orlovv/reviews_of_works

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3ae1183 · Dec 10, 2023
May 29, 2023
May 8, 2023
May 8, 2023
Dec 10, 2023
May 8, 2023
May 19, 2023
May 8, 2023

Repository files navigation

Отзывы на произведения

Описание

Назначение проекта

С помощью этого API можно получить доступ к различным произведениям разного жанра, будь то книга о приключениях Дон Кихота, старая песня "The Beatles - All you need is love" или фильм ужасов "Зомби в Париже" в рамках проекта. Пользователи также могут оставлять ревью к каждому творению, а если кто-то будет не согласен с таким мнением, то всегда можно оставить злостный комментарий.

Требования и зависимости

  • requests==2.26.0
  • Django==3.2
  • djangorestframework==3.12.4
  • PyJWT==2.1.0
  • pytest==6.2.4
  • pytest-django==4.4.0
  • pytest-pythonpath==0.7.3
  • djangorestframework-simplejwt
  • shortuuid
  • django-filter

Зачем был реализован проект?

Проект создан с целью обучения совместной работе, soft-скиллов и работе с Git, а также закреплению знаний об API, Django REST framework.

Технологии

Django, Django REST Framework, Djoser, JWT, Sqlite, Git, GitHub, sqlite3

🚀 Инструкция по развертыванию и запуску

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

git clone https://github.com/daniil-orlovv/api_yamdb.git
cd api_yamdb

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

python -m venv venv
source venv/Scripts/activate

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

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

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

python manage.py migrate

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

python manage.py runserver

Примеры запросов к API

Прежде чем получить начать работу с API, рекомендуется выполнить POST-запрос для регистрации, чтобы для использования:

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

На почту придёт код подтверждения, при отправке которого с выданного ресурса будет прислан код авторизации:

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

Чтобы получить список произведений, жанров или категорий достаточно выполнить такие GET-запросы:

http://127.0.01:8000/api/v1/titles/
http://127.0.01:8000/api/v1/genres/
http://127.0.01:8000/api/v1/categories/

Чтобы получить информацию об отзывах определённого произведения достаточно выполнить GET-запрос, а также есть возможность оставить свой отзыв с рейтингом, выполнив POST-запрос:

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

Чтобы получить информацию о комментариях определённого отзыва достаточно выполнить GET-запрос, а также есть возможность оставить свой комментарий, выполнив POST-запрос:

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

Авторы

About

Проект, позволяющий собирать отзывы на различные произведения от разных пользователей

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published