Giter Club home page Giter Club logo

api_final_yatube's Introduction

Yatube API

Описание

(ノ◕ヮ◕)ノ*:・゚✧ Реализация соц. сети Yatube на архитектуре REST API.

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

 

API основана на Django REST Framework

JWT аутентификация основана на Djoser и Simple JWT

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

◾ Клонируйте репозиторий и перейти в него

◾ Установите и активируйте виртуальное окружение

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

pip install -r requirements.txt

◾ В папке с файлом manage.py выполните миграции:

python manage.py migrate

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

python manage.py runserver

Эндпоинты

Список доступных эндпоинтов в проекте.

Действия со значком 🔐 доступны только для авторизованных пользователей с помощью токена.

 

Токен доступа

🔷 api/v1/jwt/create/

Поддерживаемые методы: POST

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

 

🔷 api/v1/jwt/refresh/

Поддерживаемые методы: POST

  • Обновление JWT-токена

 

🔷 api/v1/jwt/verify/

Поддерживаемые методы: POST

  • Проверка JWT-токена

Посты

🔷 api/v1/posts/

Поддерживаемые методы: GET | POST

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

 

🔷 api/v1/posts/{id}/

Поддерживаемые методы: GET | PUT | PATCH | DEL

  • Получение публикации
  • Обновление публикации 🔐
  • Частичное обновление публикации 🔐
  • Удаление публикации 🔐

Комментарии к постам

🔷 api/v1/posts/{post_id}/comments/

Поддерживаемые методы: GET | POST

  • Получение всех комментариев к публикации
  • Добавление нового комментария к публикации 🔐

 

🔷 api/v1/posts/{post_id}/comments/{id}/

Поддерживаемые методы: GET | PUT | PATCH | DEL

  • Получение комментария
  • Обновление комментария 🔐
  • Частичное обновление комментария 🔐
  • Удаление комментария 🔐

Группы

🔷 api/v1/groups/

Поддерживаемые методы: GET

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

 

🔷 api/v1/groups/{id}/

Поддерживаемые методы: GET

  • Получение информации о сообществе

Подписки на пользователей

🔷 api/v1/follow/

Поддерживаемые методы: GET | POST

  • Получение всех подписок пользователя, сделавшего запрос 🔐
  • Подписка пользователя от имени которого сделан запрос на пользователя переданного в теле запроса 🔐

api_final_yatube's People

Contributors

sasha0090 avatar

Watchers

James Cloos avatar  avatar

api_final_yatube's Issues

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.