Files
nyaKazuha 8fc93b8f39
bat-rust / Build and test Rust (push) Canceled after 0s
bat-rust / Build and test Go API (push) Canceled after 0s
docs: document Translation Memory and config contracts
2026-09-06 22:52:10 +08:00
..

API 文档

本目录是 API 文档入口。当前实现分为两层,不能把 Rust daemon RPC 和 Go HTTP 服务混写成一个接口:

Rust daemon RPC

Rust bat 通过 /tmp/bat-pid/bat.sock 提供换行分隔的 JSON-RPC 2.0 Resource Backend。方法、参数、envelope、错误码、Go 调用白名单以 rpc-backend-api.md 为准。

Go bat-api HTTP

Go cmd/bat-api 是资源 bootstrap、已发布资源分发和鉴权控制服务,不是完整 游戏业务 API。已实现的 HTTP surface 包括:

  • /healthz/readyz
  • /v1/bootstrap/v1/launcher/bootstrap/v1/release/v1/resources
  • /v1/server-info 和 CDN 形状资源路径
  • /api/launcher/game/config 兼容端点
  • /admin/ 与白名单 /admin/control/{action};其中翻译管理面包含 /admin/translation/tasks/admin/translation/handoff/admin/translation/memory/summary/admin/translation/memory/querytranslation-memory-confirm 转发
  • /openapi.yaml

HTTP 路由的 OpenAPI 文本由 internal/api/openapi.go 提供,运行中的服务也可 通过 GET /openapi.yaml 获取。配置、鉴权、部署边界和示例见 USERGUIDE.mdGO_STATUS.md

账号登录、完整翻译管理、术语库、游戏业务协议和完整 launcher 安装包更新链 当前不属于已实现接口。