/singers-drf-project

Каталог исполнителей и их альбомов с песнями

Primary LanguagePythonMIT LicenseMIT

Каталог исполнителей и их альбомов с песнями

API-сервис позволяет создавать и управлять каталогом исполнителей и их альбомами с песнями.

Стек технологий

Django-app workflow

Python Django Django REST Framework PostgreSQL Docker Docker-compose Nginx gunicorn

  • Python 3.10
  • Django 4.1.7
  • Django REST Framework 3.14.0

Установка и запуск

  1. Cклонировать репозиторий git@github.com:iricshkin/singers-drf-project.git

  2. Создать и заполнить .env файл по аналогии с .env.example

  3. Запустить контейнер с сервисами

sudo docker-compose up -d --build

При первом запуске для функционирования проекта выполните команды:

sudo docker-compose exec web python manage.py migrate
sudo docker-compose exec web python manage.py createsuperuser
sudo docker-compose exec web python manage.py collectstatic --no-input

После запуска проекта, подробную инструкцию можно будет посмотреть по адресу http://localhost/redoc/ или http://localhost/swagger/

Примеры обращения к API:

  • /swagger/ - Документация
  • /api/v1/albums/ - Получить список всех альбомов / Создать новый альбом
  • /api/v1/albums/{id}/ - Получить альбом по id / Обновить по id / Удалить по id
  • /api/v1/singers/ - Получить список всех исполнителей / Создать нового исполнителя
  • /api/v1/singers/{id}/ - Получить исполнителя по id / Обновить по id / Удалить по id
  • /api/v1/songs/ - Получить список всех песен / Создать новую песню
  • /api/v1/songs/{id}/ - Получить песню по id / Обновить по id / Удалить по id

Об авторе

Ирина Фок iricshkin