Tango Web API

Tango Web API: единый HTTP-сервер для модов Minecraft

Tango Web API — это библиотека для модов Minecraft на платформах Fabric и NeoForge, которая устраняет необходимость писать собственный код для создания веб-серверов. Она предоставляет единый встроенный HTTP-сервер, который другие моды могут использовать для экспонирования собственных API-конечных точек или статических файлов. Это позволяет авторам модов легко добавлять веб-интерфейсы, не занимаясь сложной настройкой Java-сервера.

Единый веб-сервер для модов

Tango Web API решает проблему избыточного кода (boilerplate), требуемого для создания веб-серверов в модах Minecraft. Вместо того чтобы каждый проект реализовывал свой HTTP-сервер, эта библиотека предоставляет единый встроенный сервер на базе Java HTTP для всех подключенных модов. Запуск и остановка сервера централизованы, что упрощает управление и повышает стабильность работы модов, использующих веб-интерфейсы.

Встроенные конечные точки и диагностика

Библиотека включает набор встроенных маршрутов для проверки работоспособности и управления сервером. Доступны следующие адреса: /tango-webapi/health для получения статуса, /tango-webapi/info для вывода конфигурации (хост, порт, лимит байт) и /tango-webapi/routes для списка всех зарегистрированных маршрутов. Эти точки доступны сразу после запуска игры и не требуют дополнительной регистрации.

Гибкая конфигурация

Поведение сервера настраивается через файл config/tango-webapi.properties или переменные окружения. В файле можно задать адрес хоста (host), порт (port) и максимальный размер входящих запросов (maxRequestBytes). Для гибкости также поддерживаются системные свойства с префиксами TANGO_WEBAPI_ (например, TANGO_WEBAPI_PORT), позволяющие управлять настройками без прямого редактирования конфигурационных файлов.

Примеры использования API

Разработчики модов могут легко создавать свои маршруты с использованием пространства имен мода в качестве префикса. Ниже приведены примеры создания текстового ответа, JSON-ответа и предоставления статических файлов:

Тестирование и проверка

После запуска игры веб-сервер доступен по адресу `http://localhost:8080`. Разработчики могут проверять встроенные маршруты (`/health`, `/info`, `/routes`) и собственные конечные точки через браузер или утилиты командной строки, такие как curl. Рекомендуется тестировать загрузку статических файлов и корректность обработки различных типов запросов.

Связанные материалы

• YetAnotherConfigLib (YACL) — похожий мод
• Just Enough Items (JEI) — похожий мод
• Geckolib — похожий мод
• More Culling — похожий мод
• Bookshelf — похожий мод

Автор: Pankraz01 · Лицензия: MIT