{"id":19704917,"url":"https://github.com/lmashik/api_yamdb-ml","last_synced_at":"2026-06-10T03:31:18.030Z","repository":{"id":206305615,"uuid":"597145614","full_name":"lmashik/api_yamdb-ml","owner":"lmashik","description":"Платформа для сбора отзывов на произведения (командная работа)","archived":false,"fork":false,"pushed_at":"2022-12-28T22:56:24.000Z","size":159,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-27T17:23:21.862Z","etag":null,"topics":["drf","postgresql","python37"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lmashik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-02-03T18:20:34.000Z","updated_at":"2023-11-08T21:28:58.000Z","dependencies_parsed_at":"2023-11-08T23:31:37.170Z","dependency_job_id":"55766f89-9d13-413a-b12d-e00b3c460821","html_url":"https://github.com/lmashik/api_yamdb-ml","commit_stats":null,"previous_names":["lmashik/api_yamdb-ml"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lmashik/api_yamdb-ml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmashik%2Fapi_yamdb-ml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmashik%2Fapi_yamdb-ml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmashik%2Fapi_yamdb-ml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmashik%2Fapi_yamdb-ml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lmashik","download_url":"https://codeload.github.com/lmashik/api_yamdb-ml/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmashik%2Fapi_yamdb-ml/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34136112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["drf","postgresql","python37"],"created_at":"2024-11-11T21:25:16.618Z","updated_at":"2026-06-10T03:31:18.015Z","avatar_url":"https://github.com/lmashik.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Проект YaMDb\n\n## Описание\nПроект YaMDb собирает отзывы (Review) пользователей на произведения (Title).\nПроизведения делятся на категории: \"Книги\", \"Фильмы\", \"Музыка\". Список категорий (Category) может быть расширен.\nСами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку.\nВ каждой категории есть произведения: книги, фильмы или музыка.\nНовые жанры может создавать только администратор.\nПользователи оставляют к произведениям текстовые отзывы (Review) и выставляют произведению рейтинг, \nа также пишут комментарии (Comments) к отзывам.\n\n## Используемые технологии\n\n - Django Rest Framework (библиотека для преобразования Django-приложения в REST API)\n - Postman (графическая программа для тестирования API)\n\n## Ресурсы API YaMDb\n**AUTH**: аутентификация.\n\n**USERS**: пользователи.\n\n**TITLES**: произведения, к которым пишут отзывы (определённый фильм, книга или песенка).\n\n**CATEGORIES**: категории (типы) произведений (\"Фильмы\", \"Книги\", \"Музыка\").\n\n**GENRES**: жанры произведений. Одно произведение может быть привязано к нескольким жанрам.\n\n**REVIEWS**: отзывы на произведения. Отзыв привязан к определённому произведению.\n\n**COMMENTS**: комментарии к отзывам. Комментарий привязан к определённому отзыву.\n\n## Пользовательские роли\n**Аноним** — может просматривать описания произведений, читать отзывы и комментарии.\n\n**Аутентифицированный пользователь (user)** — может читать всё, как и Аноним, дополнительно может публиковать отзывы и ставить рейтинг произведениям (фильмам/книгам/песенкам), может комментировать отзывы; может редактировать и удалять свои отзывы и комментарии, редактировать свои оценки произведений. Эта роль присваивается по умолчанию каждому новому пользователю.\n\n**Модератор (moderator)** — те же права, что и у Аутентифицированного пользователя, плюс право удалять и редактировать любые отзывы и комментарии.\n\n**Администратор (admin)** — полные права на управление всем контентом проекта. Может создавать и удалять произведения, категории и жанры. Может назначать роли пользователям.\n\n**Суперюзер Django** — должен всегда обладать правами администратора, пользователя с правами admin. Даже если изменить пользовательскую роль суперюзера — это не лишит его прав администратора. Суперюзер — всегда администратор, но администратор — не обязательно суперюзер.\n\n# Установка\n\n## Клонируем проект\n\nКлонировать репозиторий и перейти в него в командной строке:\n\ngit clone git@github.com:elenashovtyuk/api_yamdb.git\n\n```\ncd api_yamdb\n```\n\n## Разворачиваем проект и окружение\n\nCоздать и активировать виртуальное окружение:\n\n```\npython3 -m venv env\n```\n\n```\nsource env/bin/activate\n```\n\n ## Установим зависимости\n\n```\npython3 -m pip install --upgrade pip\n```\n\n```\npip install -r requirements.txt\n```\n\n ## Выполним миграции\n\n```\npython3 manage.py migrate\n```\n\n ## Запускаем проект\n\n```\npython3 manage.py runserver\n```\n\n# Примеры запросов к API\n\nДля доступа к API необходимо зарегистрироваться (получить код подтверждения):\n\n1. Для этого нужно выполнить POST-запрос по указанному эндпоинту с использованием \"username\" и \"email\":\n\n```\n{\n\"email\": \"user@example.com\",\n\"username\": \"user\"\n}\n```\n\n```\nhttp://127.0.0.1:8000/api/v1/auth/signup/\n```\nВ ответ YaMDB отправляет письмо с кодом подтверждения (confirmation_code) на адрес email.\n\n2. Отправить POST-запрос по указанному эндпоинту с параметрами \"username\" и \"confirmation_code\":\n\n```\n{\n\"username\": \"user\",\n\"confirmation_code\": \"string\"\n}\n```\n\n```\nhttp://127.0.0:8000/api/v1/auth/token/\n```\nВ ответ пользователь получает токен (JWT-токен):\n\n```\n{\n\"token\": \"string\"\n}\n```\n\n3. При желании пользователь может отправить POST-запрос на следующий эндпоинт, заполняет поля в своем профиле:\n\n```\nhttp://127.0.0:8000/api/v1/users/me/\n```\n\n\nДальше пользователь может работать с API, отправляя этот токен с каждым запросом.\nВозможные ресурсы API:\n\n```\n/api/v1/categories/ (GET, POST)\n\n/api/v1/categories/{slug}/ (DELETE)\n\n/api/v1/genres/ (GET, POST)\n\n/api/v1/genres/{slug}/ (DELETE)\n\n/api/v1/titles/ (GET, POST)\n\n/api/v1/titles/{titles_id}/ (GET, PATCH, DELETE)\n\n/api/v1/titles/{title_id}/reviews/ (GET, POST)\n\n/api/v1/titles/{title_id}/reviews/{review_id}/ (GET, PATCH, DELETE)\n\n/api/v1/titles/{title_id}/reviews/{review_id}/comments/ (GET, POST)\n\n/api/v1/titles/{title_id}/reviews/{review_id}/comments/{comment_id}/ (GET, PATCH, DELETE)\n\n/api/v1/users/ (GET, POST)\n\n/api/v1/{username}/ (GET, PATCH, DELETE)\n\n/api/v1/users/me/ (GET, PATCH)\n```\n\n\n# Авторы проекта\nШовтюк Елена, Михайлова Мария, Пиголкин Андрей\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmashik%2Fapi_yamdb-ml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flmashik%2Fapi_yamdb-ml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmashik%2Fapi_yamdb-ml/lists"}