Данный проект представляет собой веб-приложение, разработанное с использованием фреймворка Django. Оно предоставляет API для работы с социальной сетью, позволяя пользователям выполнять различные действия, такие как получение информации о пользователях, постах, группах и комментариях, а также создание новых постов и подписка на других пользователей. Это API может быть использовано как на сайте самой социальной сети, так и для интеграции со сторонними приложениями и сервисами.
- Django 3.2.16
- Django REST framework 3.12.4
- PyJWT 2.1.0
- SQLite3
Чтобы установить и запустить проект, выполните следующие шаги:
- Склонируйте репозиторий на свой компьютер:
git clone git@github.com:VlKazmin/api_final_yatube.git
- Создайте виртуальное окружение:
python -m venv venv
- Активируйте виртуальное окружение:
. venv/bin/activate - Установите необходимые зависимости:
pip install -r requirements.txt
- Выполните миграции:
cd yatube_api python manage.py migrate - Создайте суперпользователя:
python manage.py createsuperuser
- Запустите сервер:
python manage.py runserver
- Откройте веб-браузер и перейдите по адресу:
http://127.0.0.1:8000/api/v1/
Для использования API выполните следующие шаги:
- Получите токен аутентификации по адресу:
http://127.0.0.1:8000/api/v1/jwt/create/
- При запросе к защищенным эндпоинтам в заголовке запроса передавайте токен в формате:
Authorization: Bearer <ваш токен>
Документация API доступна по адресу http://localhost:8000/api/v1/redoc/.
Python 3.7 или выше Установленные зависимости из файла requirements.txt
Проект использует следующий стек технологий:
- Django и Django REST framework для разработки API
- PyJWT для аутентификации и управления токенами
- SQLite3 в качестве базы данных