API для Yatube

Описание:

Реализация Application Programming Interface для проекта Yatube.

Используемые технологии:

Python, Django, JWT

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

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

git clone git@github.com:ase77/api_final_yatube.git

cd api_final_yatube

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

Если у вас Linux/MacOS

python3 -m venv venv
source venv/bin/activate

Если у вас Windows

python -m venv venv
source venv/Scripts/activate

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

python3 -m pip install --upgrade pip
pip install -r requirements.txt

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

python3 manage.py migrate

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

python3 manage.py runserver

После запуска проекта, документация к API будет доступна по адресу:

http://127.0.0.1:8000/redoc/

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

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

GET http://127.0.0.1:8000/api/v1/posts/
GET http://127.0.0.1:8000/api/v1/posts/?limit=2&offset=3

{
    "id": 0,
    "author": "string",
    "text": "string",
    "pub_date": "2021-10-14T20:41:29.648Z",
    "image": "string",
    "group": 0
}

Добавление новой публикации. Анонимные запросы запрещены:

POST http://127.0.0.1:8000/api/v1/posts/

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

Обновление публикации по id. Обновить публикацию может только автор публикации:

PUT http://127.0.0.1:8000/api/v1/posts/{id}/

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

Частичное обновление публикации по id. Обновить публикацию может только автор публикации:

PATCH http://127.0.0.1:8000/api/v1/posts/{id}/

{
    "text": "string"
}

Удаление публикации по id. Удалить публикацию может только автор публикации:

DELETE http://127.0.0.1:8000/api/v1/posts/{id}/

Получение всех комментариев к публикации:

GET http://127.0.0.1:8000/api/v1/posts/{post_id}/comments/

{
    "id": 0,
    "author": "string",
    "text": "string",
    "created": "2019-08-24T14:15:22Z",
    "post": 0

}

Добавление нового комментария к публикации. Анонимные запросы запрещены:

POST http://127.0.0.1:8000/api/v1/posts/{id}/

{
    "text": "string"
}

Получение списка доступных сообществ:

GET http://127.0.0.1:8000/api/v1/groups/

{
    "id": 0,
    "title": "string",
    "slug": "string",
    "description": "string"
}

Возвращает все подписки пользователя, сделавшего запрос. Анонимные запросы запрещены:

GET http://127.0.0.1:8000/api/v1/follow/

{
    "user": "string",
    "following": "string"
}

Подписка пользователя от имени которого сделан запрос на пользователя переданного в теле запроса. Анонимные запросы запрещены:

POST http://127.0.0.1:8000/api/v1/follow/

{
    "following": "string"
}

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

POST http://127.0.0.1:8000/api/v1/jwt/create/

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

Автор проекта:

Моторин А.В.

В начало ☝️