Middle Service приложения Мини-банк

Middle Service - это один из компонентов "Мини-банка", приложения разрабатываемого в рамках программы GPB IT Factory Backend 2024. Сервис принимает запросы от Telegram-бота, выполняет валидацию и бизнес-логику, а так же маршрутизирует запросы в Backend Service.

Содержание

1. Локальный запуск
2. Запуск в Docker
3. Архитектура системы
4. Интеграции

Локальный запуск

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

   git clone git@github.com:gpb-it-factory/gladskoy-middle-service.git

2. Перейти в директорию с проектом

   cd gladskoy-middle-service

3. Запустить приложение

   ./gradlew bootRun

REST API контракт сервиса находится в директории openapi

Запуск в Docker

1. Создать общую сеть, если этого не было сделано ранее

   docker network create mini-bank-net

2. Выполнить скрипт, заменив значения переменных (<...>) корректными значениями

   docker run --network mini-bank-net \
     --name middle-service \
     --env BACKEND_SERVICE_URL=<backend_hostname> \
     -dp 8081:8081 \
     saneci/mini-bank-middle-service:<tag>

Актуальные теги тут: https://github.com/gpb-it-factory/gladskoy-middle-service/tags, указывать без префикса v

Архитектура системы

@startuml architecture
skinparam sequenceMessageAlign center
skinparam ParticipantPadding 20

participant TelegramBot
participant MiddleService
participant BackendService

TelegramBot -> MiddleService: HTTP request
activate MiddleService

MiddleService --> MiddleService: Validation
TelegramBot <-- MiddleService: HTTP error response, if not valid

MiddleService --> MiddleService: Business logic
activate MiddleService

MiddleService -> BackendService: HTTP request
activate BackendService

BackendService --> MiddleService: HTTP response
deactivate BackendService
deactivate MiddleService

MiddleService --> TelegramBot: HTTP response
deactivate MiddleService

@enduml

Интеграции

• Telegram Bot
• Backend Service // TBD