Redoc боевого сервера: http://158.160.11.22/redoc/
Проект собирает отзывы пользователей на произведения. Каждое произведение относится к определенной категории и ему может быть присвоен жанр. Пользователи могут оставлять отзыв и оценку произведению, комментировать отзывы других пользователей.
- Аноним
- Аутентифицированный пользователь
- Модератор
- Администратор
- Riviews (бэкенд проекта)
- API (API проекта)
| адрес | метод | описание |
|---|---|---|
| api/v1/auth/signup/ | POST | регистрация нового пользователя |
| api/v1/auth/signup/ | POST | получение JWT-токена |
| api/v1/categories/ | GET, POST, DELETE | получение списка всех категорий, добавление, удаление категории |
| api/v1/genres/ | GET, POST, DELETE | получение списка всех жанров, добавление, удаление жанров |
| api/v1/titles/ | GET, POST | получение списка всех произведений, добавление нового произведения |
| api/v1/titles/{title_id}/ | GET, PATCH, DELETE | получение информации о произведении по id, частичное обновление, удаление |
| api/v1/titles/{title_id}/reviews/ | GET, POST | получение списка всех отзывов, добавление нового отзыва |
| api/v1/titles/{title_id}/reviews/{review_id}/ | GET, PATCH, DELETE | получение информации о отзыве на произведение по id, частичное обновление, удаление |
| api/v1/titles/{title_id}/reviews/{review_id}/comments/ | GET, POST | получение списка всех комментариев к отзыву, добавление нового комментария |
| api/v1/titles/{title_id}/reviews/{review_id}/comments/{comment_id}/ | GET, PATCH, DELETE | получение информации о комментарии на отзыв по id, частичное обновление, удаление |
| api/v1/users/ | GET, POST | получение списка всех пользователей, добавление нового пользователя |
| api/v1/users/{username}/ | GET, PATCH, DELETE | получение информации о пользователе, частичное обновление, удаление |
| api/v1/users/me/ | GET, PATCH | получение данных своей учетной записи, изменение своей учетной записи |
импорт данных из csv, расположенных в папке api_yamdb/static/data. Маппинг файлов и моделей расположен внутри консольной команды.
python manage.py importcsv
Клонировать репозиторий и перейти в него в командной строке:
git clone [email protected]:Dimtiv/api_yamdb.git
cd api_yamdb
Cоздать и активировать виртуальное окружение:
для Linux
python3 -m venv envsource env/bin/activatepython3 -m pip install --upgrade pip
для Windows
python -m venv venvsource venv/Scripts/activatepython -m pip install --upgrade pip
Установить зависимости из файла requirements.txt:
pip install -r requirements.txt
Выполнить миграции:
для Linux
python3 manage.py migrate
для Windows
python manage.py migrate
Запустить проект:
для Linux
python3 manage.py runserver
для Windows
python manage.py runserver
Адрес
api/v1/auth/signup/
метод
POST
запрос
{ "email": "string", "username": "string" }
ответ
{ "email": "string", "username": "string" }
Адрес
/api/v1/auth/token/
метод
POST
запрос
{ "username": "string", "confirmation_code": "string" }
ответ
{ "token": "string" }
Адрес
/api/v1/categories/
метод
POST
запрос
{ "name": "string", "slug": "string" }
ответ
{ "name": "string", "slug": "string" }
Адрес
/api/v1/genres/
метод
GET
ответ
{ "count": 0, "next": "string", "previous": "string", "results": [ { "name": "string", "slug": "string" } ] }
Адрес
/api/v1/titles/
метод
POST
запрос
{ "name": "string", "year": 0, "description": "string", "genre": [ "string" ], "category": "string" }
ответ
{ "id": 0, "name": "string", "year": 0, "rating": 0, "description": "string", "genre": [ {} ], "category": { "name": "string", "slug": "string" } }
Адрес
/api/v1/titles/{title_id}/reviews/{review_id}/
метод
PATCH
запрос
{ "text": "string", "score": 1 }
ответ
{ "id": 0, "text": "string", "author": "string", "score": 1, "pub_date": "2019-08-24T14:15:22Z" }
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent