Git Product home page Git Product logo

api_final_yatube's Introduction

Api Yatube

Технологии

  • Python 3.9
  • Django 3.2.16
  • Djoser 2.2.0
  • Django REST framework 3.12.4
  • Библеотека для работы с JWT токенами simplejwt 4.7.2

Описание проекта

Апи разработано для проекта YAtube.Благодаря этому проекту можно создавать посты, подписываться на авторов и комментировать посты. Также можно создать свою страничку.Пользователь может смотреть все посты с пагинацией, подписываться на авторов и комментировать их записи.

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

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

git clone [email protected]:gleb60/api_final_yatube.git
cd kittygram

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

python3 -m venv venv

Или на Windows:

python -m venv venv

И активировать виртуальное окружение на Linux:

. venv/bin/activate

Или на Windows:

source venv/Scripts/activate

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

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

Зайти в папку приложения:

cd yatube_api

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

python3 manage.py migrate

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

python3 manage.py runserver

Доступные эндпоинты

  • api/v1/posts/ - получаем список всех постов или создаем новый пост.
  • api/v1/posts/{post_id} - получаем, редактируем или удаляем пост.
  • api/v1/posts/{post_id}/comments/ - получаем список комментариев к публикации или добавляем новый комментарий.
  • api/v1/posts/{post_id}/comments/{id} - получаем/редактируем/удаляем конкретный комментарий конкретного поста по id.
  • api/v1/groups/ - получаем список групп.
  • api/v1/groups/{id} - получаем информацию о сообществе по id.
  • api/v1/follow/ - получаем все подписки пользователя, сделавшего запрос или подписываемся на пользователя переданного в тело запроса. Анонимные запросы запрещены. Возможен поиск по подпискам по параметру search.
  • api/v1/jwt/create/ - создание JWT токена
  • api/v1/jwt/refresh/ - обновление JWT токена
  • api/v1/jwt/verify/ - проверка JWT токена

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

Пример POST запроса .../api/v1/posts/

{
    "text": "Первый пост"
}

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

{
    "id": 5,
    "author": "username",
    "text": "Первый пост",
    "pub_date": "2023-05-09T17:17:23.663450Z",
    "image": null,
    "group": null
}

Пример POST запроса .../api/v1/posts/5/comments/

{
    "text": "Первый комментарий"
}

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

{
    "id": 3,
    "author": "username",
    "text": "Первый комментарий",
    "created": "2023-05-09T17:24:40.398345Z",
    "post": 5
}

Пример GET запроса .../api/v1/follow/

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

{
    "user": "user",
    "following": "user1"
}

api_final_yatube's People

Contributors

gleb60 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.