docs: 对齐 RPC 接口文档
bat-rust / Build and test Rust (push) Canceled after 0s
bat-rust / Build and test Go API (push) Canceled after 0s

This commit is contained in:
2026-08-03 11:47:51 +08:00
parent 7c863d10d1
commit a2e2ae8ac5
4 changed files with 64 additions and 48 deletions
+21 -39
View File
@@ -1,48 +1,30 @@
# API 文档
本目录包含 BlueArchive Toolkit 的 API 文档。
本目录是 API 文档入口。当前实现分为两层,不能把 Rust daemon RPC
和 Go HTTP 服务混写成一个接口:
当前 API Server 尚未实现,本文件只记录规划边界,不代表已有可运行 HTTP 服务或 OpenAPI 产物。
## Rust daemon RPC
## OpenAPI 规范
Rust `bat` 通过 `/tmp/bat-pid/bat.sock` 提供换行分隔的 JSON-RPC 2.0
Resource Backend。方法、参数、envelope、错误码、Go 调用白名单以
[`rpc-backend-api.md`](../reference/rpc-backend-api.md) 为准。
OpenAPI 文档将在 API Server 落地后生成,目标使用 OpenAPI 3.0 标准。当前仓库尚未提供 `openapi/` 生成产物。
## Go bat-api HTTP
## 文档生成
Go `cmd/bat-api` 是资源 bootstrap、已发布资源分发和鉴权控制服务,不是完整
游戏业务 API。已实现的 HTTP surface 包括:
API 文档将在开发过程中自动生成和更新。
- `/healthz``/readyz`
- `/v1/bootstrap``/v1/launcher/bootstrap``/v1/release``/v1/resources`
- `/v1/server-info` 和 CDN 形状资源路径
- `/api/launcher/game/config` 兼容端点
- `/admin/` 与白名单 `/admin/control/{action}`
- `/openapi.yaml`
**计划**
- 使用 `swag` (Go) 从代码注释生成 OpenAPI 文档
- 提供 Swagger UI 在线查看
- 支持导出为 Markdown、HTML 等格式
HTTP 路由的 OpenAPI 文本由 `internal/api/openapi.go` 提供,运行中的服务也可
通过 `GET /openapi.yaml` 获取。配置、鉴权、部署边界和示例见
[`USERGUIDE.md`](../../USERGUIDE.md) 与
[`GO_STATUS.md`](../reports/GO_STATUS.md)。
---
## 核心 API 端点(规划中)
### 认证
- `POST /api/v1/auth/login` - 用户登录
- `POST /api/v1/auth/logout` - 用户登出
- `POST /api/v1/auth/refresh` - 刷新 Token
### 翻译管理
- `GET /api/v1/translations` - 获取翻译列表
- `POST /api/v1/translations` - 创建翻译
- `PUT /api/v1/translations/:id` - 更新翻译
- `DELETE /api/v1/translations/:id` - 删除翻译
### 术语管理
- `GET /api/v1/glossary` - 获取术语列表
- `POST /api/v1/glossary` - 创建术语
- `PUT /api/v1/glossary/:id` - 更新术语
- `DELETE /api/v1/glossary/:id` - 删除术语
### 资源同步
- `POST /api/v1/sync/start` - 启动同步
- `GET /api/v1/sync/status` - 查询同步状态
- `POST /api/v1/sync/cancel` - 取消同步
---
更多详细文档将在 API Server 实现后补充。
账号登录、完整翻译管理、术语库、游戏业务协议和完整 launcher 安装包更新链
当前不属于已实现接口。