TypeBox 作为协议真理源
TypeBox 是 TypeScript 优先的结构库。我们用它定义 Gateway WebSocket 协议(握手、请求/响应、服务器事件)。这些结构驱动运行时校验、JSON Schema 导出、macOS 应用的 Swift 代码生成。一个真理源,其余均生成。高层协议上下文见 网关架构。
心智模型(30 秒)
每条网关 WS 消息为三类帧之一:
- 请求:
{ type: "req", id, method, params } - 响应:
{ type: "res", id, ok, payload | error } - 事件:
{ type: "event", event, payload, seq?, stateVersion? }
首帧必须为 connect 请求。之后客户端可调用方法(如 health、send、chat.send)并订阅事件(如 presence、tick、agent)。
连接流程(最小)、常见方法与事件、结构位置、当前流水线、运行时如何使用结构、示例帧、最小客户端(Node.js)、端到端示例(添加方法)、Swift 代码生成行为、版本与兼容性、结构模式与约定、实时结构 JSON、变更结构时见英文 TypeBox 文档。
最后更新于: