Описание

API для проекта Yatube (Социальная сеть блогеров). У неаутентифицированных пользователей доступ к API только на чтение (за исключением эндпоинта /follow/). Аутентифицированным пользователям разрешено изменение и удаление своего контента; в остальных случаях доступ предоставляется только для чтения.

Документация к API с доступными методами находится по адресу http://127.0.0.1:8000/redoc/

Установка

1. Клонирование репозитория

git clone https://github.com/Hengich/api_final_yatube.git

2. Создание и активация виртуального окружения

python -m venv env

source env/Scripts/activate

3. Установка необходимых зависимостей из requirements

pip install -r requirements.txt

4. Миграции

python yatube_api/manage.py migrate

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

python yatube_api/manage.py runserver

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

• Получить список всех публикаций:

GET api/v1/posts/

При указании параметров limit и offset выдача будет работать с пагинацией.

• Создание публикации:

POST /api/v1/posts/

тело запроса:

{
"text": "string",
"image": "string",
"group": 0
}

• Обновление публикации:

PUT /api/v1/posts/{id}/

тело запроса:

{
"text": "string",
"image": "string",
"group": 0
}

• Удаление публикации:

DEL /api/v1/posts/{id}/

• Получение JWT-токена:

POST /api/v1/jwt/create/

тело запроса:

{
"name": "string",
"password": "string"
}

• Обновить JWT-токен:

POST /api/v1/jwt/reftesh/

• Проверить JWT-токен:

POST /api/v1/jwt/verify/

Если ваш токен утрачен, украден или каким-то иным образом скомпрометирован, вам понадобится отключить его и получить новый. Для этого отправьте POST-запрос на тот же адрес /api/v1/jwt/create/, а в теле запроса в поле refresh передайте refresh-токен.