RestAPI - 服务器管理模组

RestAPI - 服务器管理模组

一个用于Hytale服务器的HTTP API和RCON。支持带作用域的命名密钥、速率限制、每次更改的审计日志、一个OpenAPI文档和一个文档页面。默认绑定到127.0.0.1,直到你更改它。

实用

遇到问题或有想法,欢迎加入我的 Discord https://discord.gg/mKgxyk6qvb

Hytale 0.7.1 没有远程控制台、没有查询端口,也没有管理端口。服务器只从 stdin 读取命令,仅此而已。我想用 Grafana 监控服务器、从面板重启它,并让 Discord 机器人查询信息,所以 RestAPI 在服务器进程内嵌了一个小型 HTTP 服务器,自带 70 条路由。

每个请求都携带一个具名密钥,包含作用域、每分钟请求上限,以及可选的允许来源地址列表。只存储密钥的 SHA-256 哈希。通过 API 或 RCON 进行的每次更改都会写入每日审计文件,记录密钥名称和地址。

涵盖内容

玩家管理,包括踢出、封禁、白名单、传送、给予和权限组。控制台命令及其输出,以及作为实时流的服务器日志。插件重载、世界时间、天气、保存、备份,以及带倒计时的停止或重启。加入、聊天、死亡和命令事件,以流和签名 webhook 的形式提供。Prometheus 格式的 /metrics,包含 TPS 和 tick 时间。GET /openapi.json 描述当前挂载的路由,/docs 让你可以在浏览器中试用它们。

RCON 也已提供,默认关闭,供已经支持它的工具使用。任何具有 commands 作用域的密钥即为密码,并适用与 HTTP 相同的拒绝列表,因此 stop 和 RestAPI 自身的重载都会被拒绝。

命令 作用
/restapi status API 监听位置、路由、密钥、RCON 以及每个套件模组的一行状态
/restapi reload 重新读取设置、消息和密钥
/restapi keys create grafana read metrics 创建密钥并仅显示一次
/restapi keys revoke grafana 立即移除密钥
/restapi audit tail 最新的审计记录行

每条命令都需要 restapi.admin,密钥相关命令还需要 restapi.admin.keys。首次启动会创建一个名为 admin、拥有所有作用域的密钥,并在服务器日志中打印一次。GitHub 上的 README 列出了所有路由和全部 123 项设置。

与我的其他模组配合

全部为可选,每个链接都有一个设置 siblings.<id>,可选值为 auto、always 或 never。模组运行时,其路由挂载在 /api/<id> 下并拥有独立作用域,停止时被移除,因此脚本永远不会看到返回“未安装”的路由。全部八个模组启用时共有 135 条路由。

TrackerAPI 添加计数器、排行榜和日志。Coinage 添加余额和账本,配合 coinage.write,密钥可以以自己的名义转移资金。Dominion Factions 添加派系、领地声明、围攻和关系,配合 dominion.write 可执行管理操作。Feats 添加每位玩家的进度、积分榜和最近解锁。Chronicle Stats 添加玩家统计、周榜和月榜以及服务器数据系列。Atlas 添加地图链接、渲染状态、世界和标记。Lullaby 添加每个世界中谁在睡觉以及还差多少人。SocialBridge 添加玩家关联的 Discord 账号及反向查询,配合 socialbridge.write,密钥可以向其 Discord 频道发送消息。

Coinage、Dominion Factions、SocialBridge 和 RestAPI 本身尚未上架 CurseForge,上面的链接使用它们将拥有的页面。

限制

需要服务器 0.7.0 或更新版本以及 Java 25。RestAPI 有 416 个自动化测试,并能在无头 0.7.2 服务器上与我全部九个模组一起干净启动。请报告任何返回错误的内容。

没有 TLS。请保持在 127.0.0.1 上,或在前端放置带 TLS 的反向代理,README 中有 Caddy 示例。JDK Web 服务器每个 JVM 只读取一个请求时间限制,因此 Atlas、Chronicle Stats 和 RestAPI 共享该限制。

链接