api_final

Преимуществом проекта является, то что он позволяет использовать функционал приложения, не посещая сайт.

Реализован функционал, позволяющий:

• Подписаться на других авторов.
• Просматривать, создавать новые, удалять и изменять сообщения.
• Просматривать и создавать группы.
• Комментировать, смотреть, удалять и обновлять комментарии.
• Фильтровать выборку по полям.

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

---

Установка

1. Склонируйте репозиторий на локальную машину:

git clone https://github.com/akinfievds/api_final_yatube.git

2. Создайте виртуальную среду и установите зависимости:

python -m venv venv
pip install -r requirements.txt

3. Создайте и примените миграции:

python manage.py makemigrations
python manage.py migrate

Запустите сервер django:

python manage.py runserver

4. Отлично теперь всего готово к использованию API!

Примеры использования

Получение токена

1. В административной панели приложения создайте пользователя http://127.0.0.1:8000/admin/auth/user/add/

2. Отправьте POST-запрос на http://127.0.0.1/api/v1/token/ и передайте 2 поля в секции data

• имя пользователя - укажите имя пользователя.
• пароль - укажите пароль пользователя.

Примечание.

Токен доступа следует бережно хранить и не передавать третьим лицам. Используется для аутентификации пользователя. Срок службы токена - 1 год, данное значение возможно изменить в настройках.

Просмотр записей

Отправьте GET-запрос на http://127.0.0.1/api/v1/posts/.

Создание записей

Отправьте POST-запрос на http://127.0.0.1:8000/api/v1/posts/ в секции data передайте параметр text с содержанием записи. В качестве токена используйте bearer token.