Giter Club home page Giter Club logo

api_yamdb's Introduction

Проект API_YaMDb

Описание

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

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

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

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

Полная документация к API находится по эндпоинту/redoc.

Технологии:

  • Python 3.9.,
  • Django 3.2.,
  • DRF,
  • JWT,
  • SQLite

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

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

git clone [email protected]:Olga-Ustinova/api_yamdb.git

cd api_yamdb

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

python -m venv venv

source venv/Scripts/activate

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

python -m pip install --upgrade pip

pip install -r requirements.txt

4. Перейти в директорию api_yamdb и выполнить миграции:

cd api_yamdb

python manage.py makemigrations

python manage.py migrate

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

python manage.py runserver

Примеры работы с API

Для неавторизированных пользователей работа с API доступна только в режиме чтения.

Алгоритм регистрации пользователей:

  1. Пользователь отправляет POST-запрос на добавление нового пользователя с параметрами email и username на эндпоинт /api/v1/auth/signup/. Использовать имя 'me' в качестве username запрещено. Поля email и username должны быть уникальными (например, передав в Body в Postman):
{
    "username": "string", 
    "email": "string" 
}  
  1. YaMDB отправляет письмо с кодом подтверждения (confirmation_code) на адрес email.
  2. Пользователь отправляет POST-запрос с параметрами username и confirmation_code на эндпоинт /api/v1/auth/token/, в ответе на запрос ему приходит token (JWT-токен) (например, передав в Body в Postman):
{
    "username": "string", 
    "confirmation_code": "string" 
}  
  1. При желании пользователь отправляет PATCH-запрос на эндпоинт /api/v1/users/me/ и заполняет поля в своём профайле (описание полей — в документации).

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

api_yamdb's People

Contributors

olga-ustinova avatar chedeiv8 avatar iskander-haz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.