api_yamdb
API для сервиса yamdb. Позволяет оценить произведение и оставить отзыв о нём.
Технологии
Python 3.10, Django 3.2, DRF, JWT
Как запустить
- Клонируем репозиторий и переходим в него в командной строке
git clone https://github.com/QuiShimo/api_yamdb.git
cd api_yamdb
- Создаем и активируем виртуальное окружение
python -m venv venv
source venv/Scripts/activate
- Устанавливаем необходимые зависимости из requirements
pip install -r requirements.txt
- Делаем миграции
python api_yamdb/manage.py migrate
- Запускаем проект
python api_yamdb/manage.py runserver
Пользовательские роли
- Аноним — может просматривать описания произведений, читать отзывы и комментарии.
- Аутентифицированный пользователь (user) — может, как и Аноним, читать всё, дополнительно он может публиковать отзывы и ставить оценку произведениям (фильмам/книгам/песенкам), может комментировать чужие отзывы; может редактировать и удалять свои отзывы и комментарии. Эта роль присваивается по умолчанию каждому новому пользователю.
- Модератор (moderator) — те же права, что и у Аутентифицированного пользователя плюс право удалять любые отзывы и комментарии.
- Администратор (admin) — полные права на управление всем контентом проекта. Может создавать и удалять произведения, категории и жанры. Может назначать роли пользователям.
- Суперюзер Django — обладает правами администратора (admin)
Примеры работы с API для всех пользователей
Подробная документация доступна по эндпоинту /redoc/
Для неавторизованных пользователей работа с API доступна в режиме чтения, что-либо изменить или создать не получится.
Права доступа: Доступно без токена.
GET /api/v1/categories/ - Получение списка всех категорий
GET /api/v1/genres/ - Получение списка всех жанров
GET /api/v1/titles/ - Получение списка всех произведений
GET /api/v1/titles/{title_id}/reviews/ - Получение списка всех отзывов
GET /api/v1/titles/{title_id}/reviews/{review_id}/comments/ - Получение списка всех комментариев к отзыву
Права доступа: Администратор
GET /api/v1/users/ - Получение списка всех пользователей
Регистрация нового пользователя
Регистрация нового пользователя: Права доступа: Доступно без токена.
POST /api/v1/auth/signup/
{
"email": "string",
"username": "string"
}
Получение JWT-токена:
POST /api/v1/auth/token/
{
"username": "string",
"confirmation_code": "string"
}
Примеры работы с API для авторизованных пользователей
Добавление категории:
Права доступа: Администратор.
POST /api/v1/categories/
{
"name": "string",
"slug": "string"
}
Удаление категории:
Права доступа: Администратор.
DELETE /api/v1/categories/{slug}/
Добавление жанра:
Права доступа: Администратор.
POST /api/v1/genres/
{
"name": "string",
"slug": "string"
}
Удаление жанра:
Права доступа: Администратор.
DELETE /api/v1/genres/{slug}/
Обновление публикации:
PUT /api/v1/posts/{id}/
{
"text": "string",
"image": "string",
"group": 0
}
Добавление произведения:
Права доступа: Администратор.
Нельзя добавлять произведения, которые еще не вышли (год выпуска не может быть больше текущего).
POST /api/v1/titles/
{
"name": "string",
"year": 0,
"description": "string",
"genre": [
"string"
],
"category": "string"
}
Добавление произведения:
Права доступа: Доступно без токена
GET /api/v1/titles/{titles_id}/
{
"id": 0,
"name": "string",
"year": 0,
"rating": 0,
"description": "string",
"genre": [
{
"name": "string",
"slug": "string"
}
],
"category": {
"name": "string",
"slug": "string"
}
}
Частичное обновление информации о произведении:
Права доступа: Администратор
PATCH /api/v1/titles/{titles_id}/
{
"name": "string",
"year": 0,
"description": "string",
"genre": [
"string"
],
"category": "string"
}
Частичное обновление информации о произведении:
Права доступа: Администратор
DEL /api/v1/titles/{titles_id}/
Работа с пользователями:
Для работы с пользователя есть некоторые ограничения для работы с ними. Получение списка всех пользователей.
Права доступа: Администратор
GET /api/v1/users/ - Получение списка всех пользователей
Добавление пользователя:
Права доступа: Администратор
Поля email и username должны быть уникальными.
POST /api/v1/users/ - Добавление пользователя
{
"username": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"bio": "string",
"role": "user"
}
Получение пользователя по username:
Права доступа: Администратор
GET /api/v1/users/{username}/ - Получение пользователя по username
Изменение данных пользователя по username:
Права доступа: Администратор
PATCH /api/v1/users/{username}/ - Изменение данных пользователя по username
{
"username": "string",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"bio": "string",
"role": "user"
}
Удаление пользователя по username:
Права доступа: Администратор
DELETE /api/v1/users/{username}/ - Удаление пользователя по username
Получение данных своей учетной записи:
Права доступа: Любой авторизованный пользователь
GET /api/v1/users/me/ - Получение данных своей учетной записи
Изменение данных своей учетной записи:
- Права доступа: Любой авторизованный пользователь
PATCH /api/v1/users/me/ # Изменение данных своей учетной записи