WebSocket Service

Микросервис, отвечающий за список серверов и их мониторинг.

Содержимое

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

Сборка

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

cargo build --release

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

Деплой

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

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

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

Эндпоинты

GET /(server|client)s

Описание

Возвращает список (сервер|клиент)ов

GET /(server|client)/{id}

Описание

Возвращает (сервер|клиент) по Id

POST /(server|client)/{id}

Описание

Добавляет (сервер|клиент).

Тело

Клиент

{
  "name": "",
  "description": "",
  "modloader": "Forge | Fabric",
  "version": "x.x.x",
  "mods": [""]
}

Сервер

{
  "name": "",
  "client": "name клиента",
  "ip": "x.x.x.x:xxxxx",
  "icon": "image url",
  "background": "image url"
}

PATCH /(server|client)/{id}

Описание

Обновляет запись о (сервер|клиент)е

Тело

{}

DELETE /(server|client)/{id}

Описание

Удаляет (сервер|клиент)