Git Product home page Git Product logo

api_final_yatube-2's Introduction

API для проекта Yatube


1. Описание

Проект API для социальной сети Yatube.
Позволяет создавать, читать, изменять и удалять свои посты, а так же читать чужие посты и подписываться на их авторов посредством API-запросов.
Для неавторизованных пользователей API доступен только для чтения.


2. Команды для запуска

Перед запуском необходимо склонировать проект:

HTTPS: git clone https://github.com/DIABLik666/api_final_yatube.git
SSH: git clone [email protected]:DIABLik666/api_final_yatube.git

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

python -m venv venv
Linux: source venv/bin/activate
Windows: source venv/Scripts/activate

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

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

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

python3 manage.py migrate

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

python3 manage.py runserver

Теперь доступность проекта можно проверить по адресу http://localhost/admin/


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

Посты:

"/api/v1/posts/" (Параметры для фильтрации "?limit=0&offset=0"),
"/api/v1/posts/{id}/"

Группы:

"/api/v1/groups/",
"/api/v1/groups/{id}/"

Комментарии:

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

Подписки (Только для авторизованных пользователей):

"/api/v1/follow/" (Параметр для поиска "?search=''")

Получение токена для доступа к API (Для зарегистрированных пользователей):

"/api/v1/auth/jwt/create/"

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

Получение списка всех постов:

Method: GET
Endpoint: "/api/v1/posts/"

Публикация поста:

Method: POST
Endpoint: "/api/v1/posts/"
Payload:
{
    "text": "string",
    "image": "string",
    "group": 0
}

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

Method: POST
Endpoint: "/api/v1/auth/jwt/create/"
Payload:
{
    "username": "string",
    "password": "string"
}

5. Техническая информация

Стек технологий: Python 3, Django, Django Rest, simple JWT.


6. Об авторе

Бормотов Алексей Викторович
Python-разработчик (Backend)
Россия, г. Кемерово
E-mail: [email protected]
Telegram: @DIABLik666

api_final_yatube-2's People

Contributors

alexey-bormotov 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.