anborovik/test_task_vk

Тестовое задание VK. Django-сервис друзей.

Документация:

Файл swagger.yaml. Для открытия использовать https://editor.swagger.io/.

Запуск:

Установить Docker:

• См. https://docs.docker.com/engine/install/

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

• git clone [email protected]:AnastasiaNB/test_task_VK.git

Создать файл с переменными окружения:

• Изменить расширение файла .env.example на .env

Собрать образ на основе Dockerfile:

• sudo docker build -t test_task_vk .

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

• sudo docker run --name test_task_vk -it -p 8000:8000 test_task_vk

Основные эндпоинты:

Регистрация нового юзера: http://0.0.0.0:8000/api/users/

POST-запрос. В теле передать JSON, содержащий поля username, email и password.

Получение токена для авторизации: http://0.0.0.0:8000/api/token/login/

POST-запрос. В теле передать JSON, содержащий поля username и password. В ответ придет auth_token, который необходимо передавать в хедере Authorization Token.

Список юзеров: http://0.0.0.0:8000/api/users/

GET-запрос. Отображает информацию обо всех зарегистрированных юзерах.

Информация о конкретном юзере: http://0.0.0.0:8000/api/users/id/

GET-запрос. Отображает информацию о юзере с указанным id. Здесь же отображается "статус дружбы".

Информация о текущем юзере: http://0.0.0.0:8000/api/users/me/

GET-запрос. Отображает профиль текущего юзера.

Список друзей: http://0.0.0.0:8000/api/users/my_friends/

GET-запрос. Отображает список друзей.

Список подписчиков: http://0.0.0.0:8000/api/users/my_followers/

GET-запрос. Отображает список подписчиков.

Список подписок: http://0.0.0.0:8000/api/users/i_follow/

GET-запрос. Отображает список подписок.

Отправить заявку в друзья: http://0.0.0.0:8000/api/friends/id/

POST-запрос. Отправляет юзеру с указанным id заявку в друзья. Если юзер хочет принять заявку, он отправляет аналогичный запрос с id юзера, чью заявку принимает. Если юзер не хочет принимать заявку, он ничего не делает.

Удалить заявку в друзья: http://0.0.0.0:8000/api/friends/id/

DELETE-запрос. Удаляет исходящую заявку в друзья для юзера с указанным id. Используется как для удаления заявки, отправленной по ошибке, так и для удаления из друзей юзера с указанным id.

Запуск тестов:

• python3 test_task_VK/manage.py test