Giter VIP home page Giter VIP logo

api_yatube's Introduction

REST API для работы с веб-сайтом YaTube.

Описание

Позволяет просматривать, добавлять, редактировать и удалять следующие ресурсы:

  • посты
  • комментарии к постам
  • группы (только в режиме чтения)

Виды запросов к API

  1. Эндпойнт api/v1/api-token-auth/
  • GET - получение токена
  1. Эндпойнт api/v1/posts/
  • GET - получение списка постов
  • POST - создание нового поста
  1. Эндпойнт api/v1/posts/{post_id}/
  • GET - получение поста с указанным id
  • PUT - полное изменение поста
  • PATCH - частичное изменение поста
  • DELETE - удаление поста
  1. Эндпойнт api/v1/groups/
  • GET - получение списка доступных сообществ
  1. Эндпойнт api/v1/groups/{group_id}/
  • GET - получение информации о сообществе по id
  1. Эндпойнт api/v1/posts/{post_id}/comments/
  • GET - получение списка комментариев для поста с указанным id
  • POST - создание нового нового комментария для поста с указанным id
  1. Эндпойнт api/v1/posts/{post_id}/comments/{comment_id}/
  • GET - получение комментария с указанным id
  • PUT - полное изменение комментария
  • PATCH - частичное изменение комментария
  • DELETE - удаление комментария

Технологии

  • Python 3.9
  • Django REST framework 3.12
  • Django 2.2

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

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

Автор

Пестова Арина Витальевна

api_yatube's People

Contributors

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