Skip to content

Latest commit

 

History

History
140 lines (118 loc) · 6.12 KB

README.md

File metadata and controls

140 lines (118 loc) · 6.12 KB

API для Yamdp - учебный групповой проект.

Получены навыки создания REST API с помощью библиотеки Django REST Framework. Через этот интерфейс смогут работать мобильное приложение или чат-бот; данные через этот API можно будет передавать и на фронтенд.

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

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

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

Пользователи могут оставлять комментарии к отзывам.

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

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

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

git clone [email protected]:CuriousGecko/api_yamdb.git

cd api_yamdb

Cоздать виртуальное окружение, если у вас Linux/macOS - (python3):

python3 -m venv env

Если Windows - (python):

python -m venv env

Активировать виртуальное окружение, если у вас Linux/macOS:

source env/bin/activate

Если у вас Windows:

source env/scripts/activate

Обновить pip

python3 -m pip install --upgrade pip

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

pip install -r requirements.txt

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

python3 manage.py migrate

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

python3 manage.py runserver

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

1. Создание, просмотр и редактирование постов.

  • POST api/v1/categories/ - адрес для POST-запроса для создания новой категори;
    • Пример ответа:
      { 
      "name": "string",
      "slug": "string"
  }
  • GET api/v1/categories/ - адрес для GET-запроса списка категорий;
    • Пример ответа:
      {
      "count": 0,
      "next": "string",
      "previous": "string",
      "results": [
          {}
      ]
  }
  • DELETE api/v1/categories/{slug}}/ - адрес для DELETE-запроса для удаления конкретной записи.

2. Создание и просмотр отзывов к произведению.

  • GET api/v1/titles/{title_id}/reviews/{review_id}/ - адрес для GET, PATCH и DELETE-запросов для, соответственно, получения, частичного редактирования и удаления конкретного отзыва;
    • Пример ответа:
      {
      "id": 0,
      "text": "string",
      "author": "string",
      "score": 1,
      "pub_date": "2019-08-24T14:15:22Z"
  }
  • POST api/v1/titles/{title_id}/reviews/ - адрес для POST-запроса для создания нового отзыва;
  • GET api/v1/titles/{title_id}/reviews/ - адрес для получения списка отзывов.

3. Регистрация и получение токена.

  • POST api/v1/auth/signup/ - адрес для POST-запроса для регистрации пользователя

    • Пример ответа:
      {
      "email": "string",
      "username": "string"
  }

  • POST api/v1/auth/token/ - адрес для получение токена

    • Пример запроса:
      {
      "username": "string",
      "confirmation_code": "string"
  }
    • Пример ответа:
      {
      "token": "string"
  }

Полная документация.

  • GET redoc/ - адрес для получения полной документации.

Используемые технологии:

Проект создан с помощью Django REST framework, аутентификация настроена с помощью Simple JWT. Полный список библиотек в файле requirements.txt.

Авторы: