krivse / API_Yatube

🔖✏️🖇К проекту социальной сети - Yatube была добавлена API, теперь можно обрабатывать все виды запросов. Здесь реализованы следующие возможности: публикация и комментирование записей, а еще можно подписываться или отписываться от авторов. К тому же предоставляется готовая документация ReDoc.

API_yatube

Построение RESTful API для Yatube

Описание

Продолжение проекта Yatube - блога, к которому создали API для обработки запросов. В данном проекте рассматриваются виды запросов: GET, POST, PATCH, PUT, DELETE

Функционал

• Подписка и отписка от авторизованного пользователя;

• Авторизованный пользователь просматривает посты, создавёт новые, удаляет и изменяет их;

• Просмотр сообществ;

• Комментирование, просмотр, удаление и обновление комментариев;

• Фльтрация по полям.

Обработка всех видов запросов для постов (получить, изменить, удалить, создать), для 3-х последних требуется специальные permissions:

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

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

git clone [e-mail]:krivse/API_Yatube.git

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

python3 -m venv venv

# для OS Lunix и MacOS
source venv/bin/activate

# для OS Windows
source venv/Scripts/activate

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

python3 -m pip install --upgrade pip

pip install -r requirements.txt

Выполнить миграции:

cd yatube
python3 manage.py makemigrations
python3 manage.py migrate

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

python3 manage.py runserver

Примеры запросов

Получение токена

Отправить POST-запрос на адрес api/v1/jwt/create/ и передать 2 поля в data:

• username - логин пользователя.
• password - пароль пользователя.

Создание поста

Отправить POST-запрос на адрес api/v1/posts/ и передать обязательное поле text, в заголовке указать Authorization:Bearer <токен>.

Пример запроса:

{
  "text": "testpost"
}

Пример ответа:

{
  "id": 1,

  "author": "krivse",

  "text": "testpost",

  "pub_date": "2022-07-22T12:12:22.021094Z",

  "image": null,

  "group": null
}

Комментирование поста пользователя

Отправить POST-запрос на адрес api/v1/posts/{post_id}/comments/ и передать обязательные поля post и text, в заголовке указать Authorization:Bearer <токен>.

Пример запроса:

{
  "post": 1,
  "text": "test"
}

Пример ответа:

{
 "id": 1,
 "author": "krivse",
 "text": "test",
 "created": "2022-07-22T12:12:13.146875Z",
 "post": 1
}

Ресурсы

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

Удобная площадка для работы с запросамия: https://www.postman.com/

Автор - Иван Красников, 2022