Skip to content

VadimShara/filmoteka_VK_test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Тестовое задание VK

Требования

Разработать бэкенд приложения “Фильмотека”, который предоставляет REST API для управления базой данных фильмов.

Функциональные возможности

Приложение должно поддерживать следующие функции:

  • добавление информации об актёре (имя, пол, дата рождения),
  • изменение информации об актёре.

Возможно изменить любую информацию об актёре, как частично, так и полностью:

  • удаление информации об актёре,
  • добавление информации о фильме.

При добавлении фильма указываются его название (не менее 1 и не более 150 символов), описание (не более 1000 символов), дата выпуска, рейтинг (от 0 до 10) и список актёров:

  • изменение информации о фильме.

Возможно изменить любую информацию о фильме, как частично, так и полностью:

  • удаление информации о фильме,
  • получение списка фильмов с возможностью сортировки по названию, по рейтингу, по дате выпуска. По умолчанию используется сортировка по рейтингу (по убыванию),
  • поиск фильма по фрагменту названия, по фрагменту имени актёра,
  • получение списка актёров, для каждого актёра выдаётся также список фильмов с его участием,
  • API должен быть закрыт авторизацией,
  • поддерживаются две роли пользователей - обычный пользователь и администратор. Обычный пользователь имеет доступ только на получение данных и поиск, администратор - на все действия. Для упрощения можно считать, что соответствие пользователей и ролей задаётся вручную (например, напрямую через БД).

Требования к реализации:

  • язык реализации - go,
  • для хранения данных используется реляционная СУБД (предпочтительно - PostgreSQL),
  • предоставлена спецификация на API (в формате Swagger 2.0 или OpenAPI 3.0).
  • Для реализации http сервера разрешается использовать только стандартную библиотеку http (без фреймворков).
  • Логирование - в лог должна попадать базовая информация об обрабатываемых запросах, ошибки.
  • Код приложения покрыт юнит-тестами не менее чем на 70%.
  • Dokerfile для сборки образа.
  • Docker-compose файл для запуска окружения с работающим приложением и СУБД.

Запуск сервиса

Для работы со всеми методами API, кроме Login и Sign-up, необходимо сначала авторизоваться. По умолчанию в системе нет пользователей. Для простоты реализации, при регистрации можно указать роль пользователя (admin или user). Для роли user доступны только запросы с методом GET. Для роли admin доступны все методы API.

Запуск

Конфигурация сервиса

Для конфигурирования сервиса ипользуется файл, лежащий в deploy/.env.

  • SERVER_HOST // адрес сервера с портом
  • DB_HOST // адрес БД с портом
  • DB_USER // имя пользователя для подключения к БД
  • DB_PASS // пароль пользователя для подключения к БД
  • DB_NAME // имя БД
  • JWT_SECRET // ключ шифрования jwt
  • JWT_ACCESS_TOKEN_EXPIRATION // время жизни jwt-токена
  • LOG_LEVEL // уровень логгирования

Запуск сервиса

Для запуска сервиса необходимо ввести команду:

make docker-up

Остановка сервиса

Для остановки сервиса необходимо ввести команду:

make docker-down

Просмотр логов сервиса

Для вывода логов сервиса необходимо ввести команду:

make docker-logs

Дополнительная информация

Используемые технологии

Go:

  • urfave/cli, wire, net/http, caarlos0/env, golang-jwt
  • pgx, go-playground/validator
  • testcontainers-go, slog, go-swagger3

DB:

  • PostgresSQL

Swagger:

  • OpenAPI v3

Deploy:

  • Docker, docker-compose

Swagger

Api-контракт swagger можно найти в папке api/doc/swagger.json

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages