Skip to content

Latest commit

 

History

History
82 lines (66 loc) · 2.39 KB

README.md

File metadata and controls

82 lines (66 loc) · 2.39 KB
Raw

API_bloggers_network_project

Описание:

API для api_bloggers_network_project представляет собой backend-проект социальной сети, в которой пользователи имеют возможность публиковать записи, комментировать записи, а так же подписываться или отписываться от авторов, выполнять поиск по подпискам.

Технологии:

  • Python 3.9
  • Django 3.2
  • djangorestframework
  • JWT + Djoser

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

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

git clone https://github.com/KonstantinSKS/api_bloggers_network_project.git

cd api_bloggers_network_project

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

py -3.9 -m venv venv

source venv/Scripts/activate

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

python -m pip install --upgrade pip

pip install -r requirements.txt

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

python manage.py migrate

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

python manage.py runserver

После запуска сервера документация к API будет доступна по ссылке: http://127.0.0.1:8000/redoc/

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

GET- запросы:

эндпоинт /api/v1/posts/ - Получить список всех публикаций.

эндпоинт /api/v1/posts/{id}/ - Получение публикации по id.

эндпоинт /api/v1/posts/{post_id}/comments/ - Получение всех комментариев к публикации.

POST- запросы

  • эндпоинт /api/v1/posts/ - Добавление новой публикации в коллекцию публикаций. Анонимные запросы запрещены.

в body:

{
  "text": "string",
  "image": "string",
  "group": 0
}
  • эндпоинт /api/v1/jwt/create/ - Получение JWT-токена.

в body:

{
  "username": "string",
  "password": "string"
}

Подробную документация к API проекта Yatube и примеры смотри на /redoc/

Автор: Стеблев Константин