QORMQORM v0.8.4 api 开始使用 EN

HTTP 与 SSE

由源码自动生成(TestAPIRef),请勿手工编辑。下方的路由表从代码抽取,不会与实现漂移。

qorm run 提供应用服务并暴露一小组 HTTP 接口:浏览器与之通信,AI 智能体在 /mcp 使用 MCP 工具,OTA 更新经 /update 进入。改变状态的端点要求同源请求。

路由方法用途
/GET应用外壳——服务端渲染的 HTML + 轻量客户端运行时
/eventPOST派发一个 UI 事件(动作 / 输入变化)并重新渲染
/navigatePOSTURL 路由——浏览器在前进/后退时依据地址栏驱动导航({scene,params}{back:true})
/eventsGET (SSE)SSE 事件流:服务端推送最新 HTML + 日志行
/pollGETSSE 不可用时的长轮询兜底——返回当前修订号,若有更新则附带 HTML
/logGET / POSTGET 拉取 ?since= 之后的活动条目;POST 转发一条客户端控制台日志
/presenceGET / POST协作在场——谁(人 / 智能体)正聚焦或输入在何处
/viewportGET / POST浏览器回报窗口尺寸(缩放去抖)以便响应式 when 节点在服务端重渲染;GET 读取当前值
/consoleGET日志窗口的控制台信息流页面
/logwindowGET伴随桌面应用的独立日志窗口
/windowPOST桌面窗口控制(移动 / 缩放 / 打开 / 关闭 / 聚焦)
/measurePOST浏览器回报每个节点的实测布局(x/y/w/h、计算样式)
/mcpPOSTHTTP 上的 MCP JSON-RPC——与 qorm mcp 相同的工具,共享同一活动运行时
/updatePOSTOTA:向运行中的应用应用一个新的已签名捆绑包
/rollbackPOST回滚到上一个运行的捆绑包
/dev/stateGET / POSTDevTools 状态检查器:读取或修改运行中的应用状态
/dev/treeGETDevTools 组件树:读取当前场景的节点树 JSON
/dev/highlightPOSTDevTools 高亮事件:向所有客户端广播节点高亮检查信号

/events 事件流

客户端打开 GET /events?rev=<n>(<n> 为生成其 HTML 的页面渲染修订号)并保持连接。服务端每次变化写入一条 SSE 消息:

: connected

data: <变化区域的 html>

每个 data: 帧携带客户端替换用的重渲染 HTML,并附带一行 id: <rev>,以便重连的浏览器作为 Last-Event-Id 回放。若客户端连接(或重连)时落后于活动修订号——即在其页面渲染与流打开之间有变更落定——服务端会先推送一份当前快照(rev+html+theme+route)使其重新同步,然后再继续推送;已处于最新修订号的客户端不会收到多余快照。日志与在场更新走同一条流。当代理缓冲 SSE 时,客户端回退到 GET /poll?rev=<n>