2.1 KiB
2.1 KiB
Orbit HTTP / WebSocket 接口手册
更新：2026-09-17。接口实现状态随 开发计划 更新。
当前接口状态
| 接口 | 状态 | 手册 |
|---|---|---|
GET /health/live |
已实现 | 健康检查 |
GET /health/ready |
已实现，仅验证数据库与迁移记录 | 健康检查 |
/v1/tasks 与任务管理 |
计划 P1–P3，尚未实现 | 任务接口规划 |
/v1/worker/connect |
计划 P2，尚未实现 | 协议草案 |
/v1/schedules 与计划管理 |
计划 P3，尚未实现 | 协议草案 |
/v1/events/connect |
计划 P3，尚未实现 | 协议草案 |
/v1/workflows 与流程管理 |
计划 P4–P5，尚未实现 | 流程接口规划 |
当前服务对未实现路由返回 404。健康检查就绪不表示任务调度、鉴权或流程引擎已经可用。
业务接口统一要求
下述业务契约尚在实现阶段细化，不能用于声称当前已有业务 API：
- 生产使用 HTTPS/WSS，凭据通过授权头或受控握手传递，不放入 URL。
- 应用身份、命名空间和操作权限分别校验；知道资源 ID 不等于拥有权限。
- 稳定幂等键与请求追踪 ID 分开；超时重报保留原键。
- 可能超过跨语言整数精度的 ID 和执行代次使用字符串。
- 时间为 UTC RFC 3339，时长字段带单位；查询和批量操作有上限。
- 错误码、字段、分页游标和限制值在对应阶段实现及回归后冻结。
健康接口目前直接返回状态对象。业务接口计划使用 request_id + data / error 信封，详见 通信协议。
每个正式接口的文档模板
实现时必须补齐：用途与权限、HTTP 方法和路径、请求头、字段类型/必填/默认值/限制、完整请求与响应、错误码、幂等与并发规则、超时/重试/取消语义、SDK 对应方法、可运行示例、兼容版本和已覆盖的回归场景。