Tango Web API

模组

· 作者 Pankraz01

一个用于打包模组服务器和网页界面的 API

1 本站下载 0 关注 更新于 10 个月前

最新 1.0.0 · 1.21.8 · NeoForge

一键开服(送7天)

TangoWebAPI

一个为 Fabric/NeoForge 提供的共享 Web 服务器模组,旨在减少其他模组的样板代码。TangoWebAPI 提供了一个嵌入式的 HTTP 服务器,供模组用于暴露其自身的端点或静态资源。

功能

  • 所有模组共享的 HTTP 服务器(基于 Java HTTP),在通用代码中统一启动/停止。
  • 简洁的路由 API:get/post/registerRoute,支持模组命名空间(/modid/...)。
  • 按模组提供静态文件服务(serveStatic,具备安全的路径处理机制)。
  • 内置健康检查/信息/路由列表端点:/tango-webapi/health、/tango-webapi/info、/tango-webapi/routes。
  • 通过配置文件(config/tango-webapi.properties)或环境变量/System 属性进行配置。
  • 带有简单 HTML 模板的错误页面(404/405/503)。

配置

文件:config/tango-webapi.properties

host=0.0.0.0
port=8080
maxRequestBytes=1000000

或通过环境变量/System 属性配置:

  • TANGO_WEBAPI_HOST / tango.webapi.host
  • TANGO_WEBAPI_PORT / tango.webapi.port
  • TANGO_WEBAPI_MAX_BYTES / tango.webapi.max_bytes

供其他模组使用的 API(示例)

// 在 /mymod/ping 处注册一个简单的文本路由
TangoWebAPI.get("mymod", "/ping", ctx -> ctx.sendText(200, "pong"));

// JSON 响应
TangoWebAPI.post("mymod", "/data", ctx -> ctx.sendJson(200, "{\"ok\":true}"));

// 从 config/mymod/static 目录下提供静态资源,路径映射到 /mymod/static/**
TangoWebAPI.serveStatic("mymod", "static", Path.of("config", "mymod", "static"));

内置端点

  • GET /tango-webapi/health – 状态检查
  • GET /tango-webapi/info – 主机/端口/最大字节数
  • GET /tango-webapi/routes – 所有已注册的路由,包括前缀路由

测试

  • 游戏启动后:访问 http://localhost:8080/tango-webapi/health / info / routes
  • 注册您自己的路由,并通过浏览器/curl 访问它。
  • 在您的模组路径下提供一个静态页面并验证其加载情况。

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源