免费 - 开源 - 前置/API - ServerTap - 通过API获取玩家信息和操作服务器 [1.16-1.19]

插件中文名称: ServerTap

插件英文名称: ServerTap

支持的核心

Bukkit
Spigot
Paper
Purpur
PufferFish
其他Spigot下游
其他Paper下游

版权链接: https://www.spigotmc.org/resources/servertap.79031/

资源语言

英语

适配版本

1.16
1.17
1.18
1.19

插件简介

ServerTap 是一个支持 Bukkit、Spigot 和 Paper 服务器的 REST API 插件。它允许通过 HTTP、Webhooks 和 Websockets 与服务器进行交互。

@Cnzw 说:
该插件很适合用于 QQ 机器人和各种状态监测网页。

安装要求

Bukkit/Spigot/Paper 或其分支：1.16.5 或更高版本
Java：16 或更高版本
无前置插件

如何使用

将本插件文件复制到服务器的 plugins 文件夹中即完成了安装。

然后可以使用 Curl 或 Postman 或任意浏览器来访问 API。

例如，查询有关服务器信息的 API：

JSON:

$ curl http: //localhost:4567/v1/server
{
    "name": "Paper",
    "motd": "This is my MOTD",
    "version": "git-Paper-89 (MC: 1.15.2)",
    "bukkitVersion": "1.15.2-R0.1-SNAPSHOT",
    "health": {
        "cpus": 4,
        "uptime": 744,
        "totalMemory": 2010644480,
        "maxMemory": 2010644480,
        "freeMemory": 1332389360
    },
    "bannedIps": [],
    "bannedPlayers": [{
        "target": "phybros",
        "source": "Server"
    }]
}

或查询在线玩家列表的 API：

JSON:

$ curl http://localhost:4567/v1/players
[{
    "uuid": "55f584e4-f095-48e0-bb8a-eb5c87ffe494",
    "displayName": "phybros",
    "address": "localhost",
    "port": 58529,
    "exhaustion": 3.5640976,
    "exp": 0.45454547,
    "whitelisted": false,
    "banned": false,
    "op": true
}]

API 文档

插件自带 API 文档。可以在 http://服务器IP:4567/swagger 查看完整的 API 文档并且直接调试。

@Cnzw 说:
我直接导出了API接口，在这里查看。

API 验证

需要配置 plugins/ServerTap/config.yml 文件：

YAML:

useKeyAuth: true
key: some-long-super-random-string

然后，在需要在请求头（Header）中包含 key 和对应的密钥。

WebHook

ServerTap 可以在服务器上发生事件时发送 WebHook 消息。

要使用 WebHook，需要配置 plugins/ServerTap/config.yml 文件：

YAML:

webhooks:
  default:
    listener: "https://your-webhook-target.com/whatever"
    events:
    - PlayerJoin
    - PlayerQuit

目前可用的事件有：

PlayerJoin
PlayerDeath
PlayerChat
PlayerKick
PlayerQuit

WebHook 通过 POST 请求发送 JSON 数据：

JSON:

{
  "player": {
    "uuid": "55f584e4-f095-48e0-bb8a-eb5c87ffe494",
    "displayName": "phybros",
    "address": "localhost",
    "port": 52809,
    "exhaustion": 0,
    "exp": 0.5714286,
    "whitelisted": true,
    "banned": false,
    "op": true
  },
  "joinMessage": "§ephybros joined the game",
  "eventType": "PlayerJoin"
}

Websockets

ServerTap 支持正向 WebSocket ，能够实时接收服务器日志。

一旦连接，服务器上通过正常日志过滤器的任何服务器日志行都会以类似这样的 JSON 对象形式通过 WebSocket 发送：

JSON:

{
  "message": "§6/version: §fGets the version of this server including any plugins in use",
  "timestampMillis": 1631834015918,
  "loggerName": "",
  "level": "INFO"
}

WebSocket 地址是 ws://服务器IP:4567/v1/ws/console。

最后 1000 条服务器日志消息将缓存并在客户端连接时发送。您可以通过更改 config.yml 中的 websocketConsoleBuffer 来配置服务器日志缓冲区的大小。