Zip Handler API

Микросервис для проверки содержимого ZIP-архивов с хранением в MinIO и аутентификацией через Keycloak.

Техническое задание

Функционал

• Загрузка архивов: Прием ZIP-архивов до 100 МБ с проверкой целостности
• Аутентификация и авторизация: Безопасный доступ через Keycloak OAuth2
• Хранение файлов: Надежное хранение в MinIO object storage
• Валидация: Проверка целостности архивов, валидация формата и размера
• REST API: Полное API на FastAPI с автоматической документацией OpenAPI

Технологии

Инструкция запуска через Docker Compose

1. Клонировать git-репозиторий

2. Открыть проект

3. Сконфигурировать .env по шаблону

4. Выполнить команду docker compose up -d --build

5. Подождать 20 секунд и перейти на: http://127.0.0.1:8000/docs

Инструкция локального запуска

1. Клонировать git-репозиторий

2. Открыть проект

3. Сконфигурировать .env по шаблону

4. Активировать виртуальное окружение и установить зависимости

5. Выполнить команду docker compose up -d postgres_app postgres_keycloak minio keycloak

6. Выполнить команду python src/main.py и перейти на http://127.0.0.1:8000/docs

Авторизация

1. Нажать на кнопку

2. В появившемся окне вставить client_id и client_sercret, значения которых можно взять из .env-template

3. Войти в тестовый аккаунт пользователя, значение которого можно взять из keycloak_setup/keycloak_setup.json

4. После появится возможность использовать эндпоинты

Админ панели

Minio: http://127.0.0.1:9001/login Пароль и логин: minioadmin

Keycloak: http://localhost:8080 Пароль и логин: admin