Code Monkey home page Code Monkey logo

api_final_yatube's Introduction

API Yatube v1

Первая версия API популярной социальной сети для блогеров Yatube. Предоставляет доступ к данным моделей Comment, Follow, Group, Post всем пользователям на чтение (кроме модели Follow), аутентифицированным по JWT-токену пользователям - на запись и изменение только своих данных (кроме модели Group)

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

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

git clone https://github.com/cnlis/api_final_yatube.git
cd api_final_yatube

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

python3 -m venv env
source env/bin/activate

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

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

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

python3 manage.py migrate

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

python3 manage.py runserver

Полная документация к API в формате ReDoc приведена по адресу /redoc/

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

####GET-запрос на получение списка постов

/api/v1/posts/

Параметры:

  • limit - Количество публикаций на страницу
  • offset - Номер страницы после которой начинать выдачу

Пример результата:

{
    "count": 1,
    "next": null,
    "previous": "http://127.0.0.1:8000/api/v1/posts/?limit=1",
    "results": []
}

####POST-запрос на создание публикации

/api/v1/posts/

Передаваемые данные:

  • text (обязательное)
  • image
  • group

Пример результата:

{
    "id": 1,
    "author": "kirill",
    "text": "sample post",
    "pub_date": "2022-01-13T13:31:22.380496Z",
    "image": null,
    "group": null
}

####GET-запрос на получение поста

/api/v1/posts/{id}/

Пример результата:

{
    "id": 1,
    "author": "kirill",
    "text": "sample post",
    "pub_date": "2022-01-13T13:31:22.380496Z",
    "image": null,
    "group": null
}

####POST-запрос на создание комментария

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

Передаваемые данные:

  • text (обязательное)

Пример результата:

{
    "id": 1,
    "author": "kirill",
    "post": 1,
    "text": "sample comment",
    "created": "2022-01-13T13:34:36.059131Z"
}

####GET-запрос на получение комментария

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

Пример результата:

{
    "id": 1,
    "author": "kirill",
    "post": 1,
    "text": "sample comment",
    "created": "2022-01-13T13:34:36.059131Z"
}

api_final_yatube's People

Contributors

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