README.md

WebSocket Service

Микросервис, отвечающий за управление соединений WebSocket

Содержимое

• Сборка
• Деплой
• Настройка
  • Переменные окружения
• Описание эндпоинтов

Сборка

Микросервис написан на Rust, так что чтобы
собрать его вам необходимо лишь установить cargo на ваш ПК, и прописать следующую команду

cargo build --release

После успешной сборки вы сможете найти артефакт по этому пути ./target/release/wss_service.

Деплой

Команды для деплоя уже есть в нашем Puff-файле.

Узнать подробнее что такое Puff-файл

# Собирает сервис и пушит его в регистр под тегом latest
puff deploy

Настройка

Переменные окружения

REDIS_URL: string - URL для подключения к Redis. USER_URL: string - Домен до сервиса wss (ex. localhost:3000).

Эндпоинты

GET /{id}

Описание

Изменяет подключение с HTTP(s) до WebSocket(Secure)

Аутентификация

Требует JWT пользователя в хедере Authorization на проде,
Gateway должен вытащить ID пользователя из JWT.

Параметры

• id (string, обязателен): Айди пользователя

POST /send/{id}

Описание

Отправляет ивент на все активные WebSocket соединения
указанного пользователя.

Аутентификация

Внутренний эндпоинт - это значит что эндпоинт
должен быть доступен только в рамках API Gateway.