Giter Club home page Giter Club logo

api_yatube's Introduction

API для Yatube

Проект "API для Yatube" представляет собой API для социальной сети, разработанный с использованием Django и Django REST framework. Этот API предоставляет возможность пользователям создавать, просматривать и взаимодействовать с постами, комментариями, группами и подписками. API требует аутентификации и авторизации с использованием JWT-токенов (Djoser), что гарантирует сохранность и конфиденциальность пользовательских данных.

Установка

  1. Клонируйте репозиторий на свой компьютер:
git clone [email protected]:SHURSHALO/api_yatube.git
  1. Создайте виртуальное окружение и активируйте его:
py -3.9 -m venv venv
source venv/Scripts/activate
  1. Установите зависимости:
pip install -r requirements.txt
  1. Примените миграции:
python manage.py migrate
  1. Создайте суперпользователя:
python manage.py createsuperuser
  1. Запустите сервер:
python manage.py runserver

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

Использование

API имеет следующие эндпоинты:

api/v1/api-token-auth/ (POST): Получение токена по логину и паролю.

api/v1/posts/ (GET, POST): Получение списка всех постов или создание нового поста.

api/v1/posts/{post_id}/ (GET, PUT, PATCH, DELETE): Получение, редактирование или удаление поста по ID.

api/v1/groups/ (GET): Получение списка всех групп.

api/v1/groups/{group_id}/ (GET): Получение информации о группе по ID.

api/v1/posts/{post_id}/comments/ (GET, POST): Получение списка всех комментариев для поста с указанным ID или создание нового комментария для данного поста.

api/v1/posts/{post_id}/comments/{comment_id}/ (GET, PUT, PATCH, DELETE): Получение, редактирование или удаление комментария по ID для поста с указанным ID.

API требует аутентификации по токену. Аутентифицированные пользователи могут редактировать и удалять только свой собственный контент. Попытка изменения чужого контента будет приводить к ошибке 403 Forbidden.

api_yatube's People

Contributors

shurshalo 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.