Skip to content

kooznitsa/splean_api

Repository files navigation

API для песен группы Сплин

Static Badge

Технологии:

Запуск проекта

git clone https://github.com/kooznitsa/splean_api.git
cd splean_api
cp .env.example .env
// Отредактировать .env при необходимости
make run                 // Запуск контейнеров Docker
make allfixtures         // Добавление записей в БД
make createsuperuser     // Создание юзера

Swagger: http://127.0.0.1:1337/v1/swagger

Admin: http://127.0.0.1:1337/admin (логин: admin, пароль: admin)

Эндпойнты

  • Альбомы:
    • albums/: список всех альбомов
    • albums/{id}: информация об альбоме по ID
    • albums/{id}/songs/: список песен по ID альбома
    • albums/stats/: статистика альбомов: самый старый, самый новый, самый длинный, самый короткий
  • Песни:
    • songs/: список всех песен
    • songs/{id}: информация о песне по ID
    • songs/{id}/lines/: строки песни по ID песни
    • songs/by-year/?year=1999: все песни данного года
    • songs/stats/: статистика песен: самая длинная, самая короткая, по числу строк, по продолжительности
  • Строки:
    • lines/: все строки всех песен
    • lines/{id}: строка по ID
    • lines/by-word/?word=мёд: строки, содержащие определенное слово или фразу
    • lines/random-line/: случайная строка
    • lines/topics/alcohol/: строки, содержащие упоминания алкогольных напитков
    • lines/topics/petersburg/: строки, содержащие упоминания Петербурга
    • lines/topics/winter/: строки про зиму
    • lines/frequent-words/: топ-100 наиболее часто встречающихся слов

Диаграмма базы данных

Диаграмма базы данных