Этот проект представляет собой Django-сервис друзей, который позволяет пользователям зарегистрироваться, отправлять и принимать заявки в друзья, управлять списком своих друзей и многое другое.
Для начала склонируйте репозиторий
git clone https://github.com/AdamRashi/friends_rest_apiСоздайте и активируйте виртуальное окружение:
python3 -m venv env
source env/bin/activateУстановите зависимости:
pip install -r requirements.txtЗапустите миграции базы данных:
python manage.py makemigrations
python manage.py migrateЗапустите сервер с помощью команды:
python manage.py runserverAPI сервиса будет доступно на http://localhost:8000/api/
Вы можете использовать интерфейс Swagger для взаимодействия с API. Для этого перейдите на http://localhost:8000/swagger/.
Для аутентификации и получения токена отправьте POST запрос на http://localhost:8000/api/token/login с параметрами username и password.
Документация API доступна в файле openapi.yml. Она также может быть найдена на странице Swagger интерфейса.
Более подробное описание и примеры использования API вы можете найти в папке docs/
Вы можете запустить этот сервис в контейнере Docker. Для этого, находясь в корневом каталоге проекта, выполните следующие команды:
Соберите Docker образ:
docker build -t <название образа> .Запустите контейнер:
docker run -d -p <порт на вашем ПК>:8000 --name <название контейнера> <название образа>
Пример:
docker build -t friends_api .
docker run -d -p 8080:8000 --name api friends_apiВ данном примере API сервиса будет доступно на http://localhost:8080/api/
Также, в дополнение к команде run, можно указать переменные окружения, например:
docker run -d -p 8080:8000 --name api friends_api -e SECRET_KEY=<ваш ключ>\
-e DJANGO_SUPERUSER_USERNAME=<username админа> \
-e DJANGO_SUPERUSER_EMAIL=<почта> \
-e DJANGO_SUPERUSER_PASSWORD=<пароль>По умолчанию, создаётся аккаунт администратора со следующими данными:
DJANGO_SUPERUSER_USERNAME='admin'
DJANGO_SUPERUSER_EMAIL='[email protected]'
DJANGO_SUPERUSER_PASSWORD='adminpassword'