@microi.net/cli 5.5.9 → 5.6.0

package/skills/v8-utilities/references/client-api-index.md

@@ -1,143 +1,143 @@
-# 前端 V8 API 索引
-
-本索引对应 `microi.doc/docs/doc/v8-engine/v8-client.md` 和当前
-`Microi.Client` V8 定义。业务表字段如 `V8.Form.OrderNo` 不属于平台函数，
-应按实际表结构理解。
-
-## 上下文与状态
-
-| API/变量 | 说明 |
-|---|---|
-| `V8.Form`、`V8.OldForm` | 当前表单与已加载旧值 |
-| `V8.FormMode` | `Add`、`Edit`、`View` |
-| `V8.FormSubmitAction` | 提交动作 |
-| `V8.FormOutAction`、`V8.FormOutAfterAction` | 表单关闭/保存后的动作状态 |
-| `V8.LoadMode` | `Design` 或真实运行模式 |
-| `V8.EventName`、`V8.Event`、`V8.KeyCode` | 当前事件、原生事件和键码 |
-| `V8.ThisValue`、`V8.OldValue` | 当前字段值；`OldValue` 主要用于表格行内事件 |
-| `V8.TableId`、`V8.TableName`、`V8.TableModel` | 当前表/表单元数据 |
-| `V8.Row`、`V8.Rows`、`V8.RowIndex`、`V8.TableRowId` | 行事件上下文 |
-| `V8.TableRowSelected`、`V8.SelectedData` | 批量选中行，兼容别名 |
-| `V8.CurrentTableData` | 当前页表格数据 |
-| `V8.SearchParam` | 当前搜索快照 |
-| `V8.SysMenuId`、`V8.SysMenuModel` | 当前授权菜单 |
-| `V8.CurrentUser`、`V8.CurrentToken` | 当前用户和 Token；不得输出到日志/URL |
-| `V8.OsClient`、`V8.SysConfig`、`V8.ClientType` | 租户、客户端配置和终端类型 |
-| `V8.DataAppend` | 打开表单、列表或弹窗时传入的附加数据 |
-| `V8.ParentV8`、`V8.ParentForm` | 子表/弹窗访问父上下文 |
-| `V8.ParentV8.Form` | 读取父级表单数据 |
-| `V8.ParentV8.FormSet(field,value)` | 从子表调用父表字段赋值与联动 |
-| `V8.ApiReplace` | 当前表单/列表接口替换配置，只读使用 |
-| `V8.Result` | 模板或事件输出槽 |
-
-## 表单与字段
-
-| API | 说明 |
-|---|---|
-| `V8.FormSet(field,value)` | 设置字段值并触发相应联动 |
-| `V8.Field` | 当前字段模型集合 |
-| `V8.FieldSet(field,prop,value)` | 修改 `Visible/Required/Readonly/Data` 等属性 |
-| `V8.FormSubmit(options)` | 提交表单；SubmitFormV8 内不得再次调用 |
-| `V8.FormClose()` | 强制关闭表单 |
-| `V8.CloseThisDialog()` | 关闭当前宿主弹窗/微应用弹窗 |
-| `V8.ReloadForm()` | 重新加载当前表单 |
-| `V8.HideFormBtn(...)` | 隐藏表单按钮 |
-| `V8.HideFormTab(name)`、`V8.ShowFormTab(name)`、`V8.ClickFormTab(name)` | 页签显隐与切换 |
-| `V8.GetFormTabs()` | 获取当前表单页签 |
-| `V8.ShowTableChildHideField(child,fields)` | 强制显示子表隐藏列并刷新 |
-| `V8.GetChildTableData(fieldName)` | 获取指定子表数据 |
-| `V8.RefreshChildTable(field,row?)` | 刷新子表 |
-
-## 列表与搜索
-
-| API | 说明 |
-|---|---|
-| `V8.RefreshTable({_PageIndex})` | 刷新当前列表 |
-| `V8.SearchSet(value)` | 替换当前模块搜索条件 |
-| `V8.SearchAppend(value)` | 追加当前模块搜索条件 |
-| `V8.OpenTableSetWhere(field,where)` | 设置弹出表格不可被临时搜索覆盖的固定范围 |
-| `V8.AppendSearchChildTable(field,value)` | 历史兼容；新代码优先 `OpenTableSetWhere` |
-| `V8.TableSearchSet(field,value)` | 替换指定子表/表格搜索 |
-| `V8.TableSearchAppend(field,value)` | 追加指定子表/表格搜索 |
-| `V8.TableRefresh(field,param)` | 刷新指定子表/表格 |
-| `V8.ClearTableSelection()` | 清空当前列表勾选 |
-
-## 交互与导航
-
-| API | 说明 |
-|---|---|
-| `V8.Tips(msg,ok?)` | 消息提示 |
-| `V8.ConfirmTips(content,callback,options?)` | HTML 模式确认框，只传可信/转义内容 |
-| `V8.Router.Push(...)` | 站内路由 |
-| `V8.Window.Open(...)` | 打开窗口 |
-| `V8.OpenForm(...)`、`V8.OpenFormWF(...)` | 历史表单/工作流打开入口 |
-| `V8.OpenAnyForm(options)` | 打开任意表单 |
-| `V8.OpenAnyTable(options)` | 打开任意列表 |
-| `V8.OpenDialog(options)` | 打开主前端已注册 Vue 组件 |
-| `V8.OpenAppDialog(options)` | 打开已发布 MicroService 页面 |
-| `V8.WF.StartWork(...)`、`V8.FormWF` | 前端工作流入口/当前工作流数据 |
-
-三个以上输入、上传、表格、步骤条、Tab 或代码编辑器使用
-`V8.OpenAppDialog`，不要在 V8 代码中拼大段 HTML。
-
-## 网络与引擎
-
-| API | 说明 |
-|---|---|
-| `V8.Http.Get(options)`、`V8.Http.Post(options)`、`V8.Http.PatchResponse(options)` | 推荐前端 HTTP Promise API |
-| `V8.Post(...)`、`V8.Get(...)` | 历史回调 API，兼容保留 |
-| `V8.ApiEngine.Run(...)` | 调用接口引擎，支持 Promise/回调 |
-| `V8.ApiEngine.RunBackground(...)` | 提交持久后台任务 |
-| `V8.DataSourceEngine` | 前端数据源引擎对象 |
-| `V8.DataSourceEngine.Run(...)` | 运行数据源引擎；旧 `GetData` 已弃用 |
-| `V8.FormEngine.GetTableData(...)` | 查询列表 |
-| `V8.FormEngine.GetFormData(...)` | 查询单条 |
-| `V8.FormEngine.DelFormData(...)` | 删除；权限仍由服务端校验 |
-
-前端 `V8.FormEngine` 真实方法以当前客户端定义为准，均可按 Promise 使用；
-不要给前端方法虚构后端专用的 `GetTableDataAsync` 名称。标准前端运行时没有公开
-`V8.ModuleEngine`，模块关联查询使用接口引擎、数据源引擎或受控 FormEngine。
-
-## 工具能力
-
-| API | 说明 |
-|---|---|
-| `V8.IsNull(value)` | 兼容判断 `null/undefined/''/'null'/'undefined'` |
-| `V8.ChineseToPinyin(text,fullPyLen,type)` | 中文转拼音 |
-| `V8.NewGuid()` | 前端生成 GUID |
-| `await V8.NewServerGuid()` | 请求服务端生成 GUID |
-| `V8.Base64.encode(value)` | 前端 Base64 编码 |
-| `V8.Base64.decode(value)` | 前端 Base64 解码 |
-| `V8.Base64.isValid(value)` | 判断字符串是否为有效 Base64 |
-| `V8._` | Underscore 实例，如 `V8._.where(...)` |
-| `V8.Action.GetDateTimeNow()` | 兼容的前端全局时间函数 |
-| `V8.AddSysLog(...)` | 前端发起系统日志记录；不得含秘密 |
-| `V8.SendSystemMessage(...)` | 发送站内系统消息 |
-| `await V8.Method.ScanCode()` | 扫码；成功值同时写入 `V8.ScanCodeRes` |
-| `V8.Print.*` | TSPL/CPCL/ESC-POS 蓝牙标签与小票打印，兼容 GP-M322、CC4，见蓝牙打印参考 |
-| `V8.Identity.GetCapabilities()` | 读取当前租户强身份能力和本人登记状态 |
-| `V8.Identity.CreateActionHash(value)` | 为稳定业务命令生成 SHA-256 摘要 |
-| `V8.Identity.RegisterPasskey(options?)` | 登记当前用户 Passkey |
-| `V8.Identity.Verify({Purpose,ActionHash,Method,Code?})` | 完成 Passkey、Authenticator TOTP 或严格人脸验证并取得一次性后端票据；Totp 需 6 位 Code |
-
-扫码应优先接收 Promise 返回值；兼容代码可在调用后读取 `V8.ScanCodeRes`。
-`V8.Identity` 是强身份验证模块。`V8.Identity.Verify` 的成功结果不能直接授权业务；后端必须重读权威数据、重算摘要并调用 `V8.Method.ConsumeIdentityVerificationTicket`。
-蓝牙打印完整 API 包含 `V8.Print.createNew`、`V8.Print.createNewESC`、
-`V8.Print.OpenBluetoothPage`、`V8.Print.isConnected`、
-`V8.Print.reconnect`、`V8.Print.getConnectionState`、`V8.Print.subscribeConnection`、
-`V8.Print.getPrinterProfile`、`V8.Print.setPrinterProfile`、
-`V8.Print.prepareSend`、`V8.Print.Send`、`V8.Print.setOneTimeData`、
-`V8.Print.setPrinterNum`、`V8.Print.disconnect` 和
-`V8.Print.BLEInformation`。其中 `Send` 依赖 `prepareSend` 设置的共享分包游标，
-只作内部状态机入口；业务代码必须调用并 `await prepareSend`。当前挂载范围、连接
-真实性、佳博原 TSPL 回归、CC4 CPCL 适配、Android SPP 与串行约束见
-[`bluetooth-print.md`](../../v8-frontend-events/references/bluetooth-print.md)，TSC/ESC
-完整方法见
-[`bluetooth-print-api.md`](../../v8-frontend-events/references/bluetooth-print-api.md)。
-
-## 主前端源码帮助对象
-
-`DiyCommon.GetApiBase()` 是 `Microi.Client` 主前端源码内部取得 API 根地址的帮助
-方法，不属于租户前端 V8 的稳定公开对象。V8 代码优先使用受控 `V8.Http` 和
-`V8.SysConfig.ApiBase`；MicroService 从宿主数据读取 `apiBase`，不要假设子应用
-全局存在 `DiyCommon`。
+# 前端 V8 API 索引
+
+本索引对应 `microi.doc/docs/doc/v8-engine/v8-client.md` 和当前
+`Microi.Client` V8 定义。业务表字段如 `V8.Form.OrderNo` 不属于平台函数，
+应按实际表结构理解。
+
+## 上下文与状态
+
+| API/变量 | 说明 |
+|---|---|
+| `V8.Form`、`V8.OldForm` | 当前表单与已加载旧值 |
+| `V8.FormMode` | `Add`、`Edit`、`View` |
+| `V8.FormSubmitAction` | 提交动作 |
+| `V8.FormOutAction`、`V8.FormOutAfterAction` | 表单关闭/保存后的动作状态 |
+| `V8.LoadMode` | `Design` 或真实运行模式 |
+| `V8.EventName`、`V8.Event`、`V8.KeyCode` | 当前事件、原生事件和键码 |
+| `V8.ThisValue`、`V8.OldValue` | 当前字段值；`OldValue` 主要用于表格行内事件 |
+| `V8.TableId`、`V8.TableName`、`V8.TableModel` | 当前表/表单元数据 |
+| `V8.Row`、`V8.Rows`、`V8.RowIndex`、`V8.TableRowId` | 行事件上下文 |
+| `V8.TableRowSelected`、`V8.SelectedData` | 批量选中行，兼容别名 |
+| `V8.CurrentTableData` | 当前页表格数据 |
+| `V8.SearchParam` | 当前搜索快照 |
+| `V8.SysMenuId`、`V8.SysMenuModel` | 当前授权菜单 |
+| `V8.CurrentUser`、`V8.CurrentToken` | 当前用户和 Token；不得输出到日志/URL |
+| `V8.OsClient`、`V8.SysConfig`、`V8.ClientType` | 租户、客户端配置和终端类型 |
+| `V8.DataAppend` | 打开表单、列表或弹窗时传入的附加数据 |
+| `V8.ParentV8`、`V8.ParentForm` | 子表/弹窗访问父上下文 |
+| `V8.ParentV8.Form` | 读取父级表单数据 |
+| `V8.ParentV8.FormSet(field,value)` | 从子表调用父表字段赋值与联动 |
+| `V8.ApiReplace` | 当前表单/列表接口替换配置，只读使用 |
+| `V8.Result` | 模板或事件输出槽 |
+
+## 表单与字段
+
+| API | 说明 |
+|---|---|
+| `V8.FormSet(field,value)` | 设置字段值并触发相应联动 |
+| `V8.Field` | 当前字段模型集合 |
+| `V8.FieldSet(field,prop,value)` | 修改 `Visible/Required/Readonly/Data` 等属性 |
+| `V8.FormSubmit(options)` | 提交表单；SubmitFormV8 内不得再次调用 |
+| `V8.FormClose()` | 强制关闭表单 |
+| `V8.CloseThisDialog()` | 关闭当前宿主弹窗/微应用弹窗 |
+| `V8.ReloadForm()` | 重新加载当前表单 |
+| `V8.HideFormBtn(...)` | 隐藏表单按钮 |
+| `V8.HideFormTab(name)`、`V8.ShowFormTab(name)`、`V8.ClickFormTab(name)` | 页签显隐与切换 |
+| `V8.GetFormTabs()` | 获取当前表单页签 |
+| `V8.ShowTableChildHideField(child,fields)` | 强制显示子表隐藏列并刷新 |
+| `V8.GetChildTableData(fieldName)` | 获取指定子表数据 |
+| `V8.RefreshChildTable(field,row?)` | 刷新子表 |
+
+## 列表与搜索
+
+| API | 说明 |
+|---|---|
+| `V8.RefreshTable({_PageIndex})` | 刷新当前列表 |
+| `V8.SearchSet(value)` | 替换当前模块搜索条件 |
+| `V8.SearchAppend(value)` | 追加当前模块搜索条件 |
+| `V8.OpenTableSetWhere(field,where)` | 设置弹出表格不可被临时搜索覆盖的固定范围 |
+| `V8.AppendSearchChildTable(field,value)` | 历史兼容；新代码优先 `OpenTableSetWhere` |
+| `V8.TableSearchSet(field,value)` | 替换指定子表/表格搜索 |
+| `V8.TableSearchAppend(field,value)` | 追加指定子表/表格搜索 |
+| `V8.TableRefresh(field,param)` | 刷新指定子表/表格 |
+| `V8.ClearTableSelection()` | 清空当前列表勾选 |
+
+## 交互与导航
+
+| API | 说明 |
+|---|---|
+| `V8.Tips(msg,ok?)` | 消息提示 |
+| `V8.ConfirmTips(content,callback,options?)` | HTML 模式确认框，只传可信/转义内容 |
+| `V8.Router.Push(...)` | 站内路由 |
+| `V8.Window.Open(...)` | 打开窗口 |
+| `V8.OpenForm(...)`、`V8.OpenFormWF(...)` | 历史表单/工作流打开入口 |
+| `V8.OpenAnyForm(options)` | 打开任意表单 |
+| `V8.OpenAnyTable(options)` | 打开任意列表 |
+| `V8.OpenDialog(options)` | 打开主前端已注册 Vue 组件 |
+| `V8.OpenAppDialog(options)` | 打开已发布 MicroService 页面 |
+| `V8.WF.StartWork(...)`、`V8.FormWF` | 前端工作流入口/当前工作流数据 |
+
+三个以上输入、上传、表格、步骤条、Tab 或代码编辑器使用
+`V8.OpenAppDialog`，不要在 V8 代码中拼大段 HTML。
+
+## 网络与引擎
+
+| API | 说明 |
+|---|---|
+| `V8.Http.Get(options)`、`V8.Http.Post(options)`、`V8.Http.PatchResponse(options)` | 推荐前端 HTTP Promise API |
+| `V8.Post(...)`、`V8.Get(...)` | 历史回调 API，兼容保留 |
+| `V8.ApiEngine.Run(...)` | 调用接口引擎，支持 Promise/回调 |
+| `V8.ApiEngine.RunBackground(...)` | 提交持久后台任务 |
+| `V8.DataSourceEngine` | 前端数据源引擎对象 |
+| `V8.DataSourceEngine.Run(...)` | 运行数据源引擎；旧 `GetData` 已弃用 |
+| `V8.FormEngine.GetTableData(...)` | 查询列表 |
+| `V8.FormEngine.GetFormData(...)` | 查询单条 |
+| `V8.FormEngine.DelFormData(...)` | 删除；权限仍由服务端校验 |
+
+前端 `V8.FormEngine` 真实方法以当前客户端定义为准，均可按 Promise 使用；
+不要给前端方法虚构后端专用的 `GetTableDataAsync` 名称。标准前端运行时没有公开
+`V8.ModuleEngine`，模块关联查询使用接口引擎、数据源引擎或受控 FormEngine。
+
+## 工具能力
+
+| API | 说明 |
+|---|---|
+| `V8.IsNull(value)` | 兼容判断 `null/undefined/''/'null'/'undefined'` |
+| `V8.ChineseToPinyin(text,fullPyLen,type)` | 中文转拼音 |
+| `V8.NewGuid()` | 前端生成 GUID |
+| `await V8.NewServerGuid()` | 请求服务端生成 GUID |
+| `V8.Base64.encode(value)` | 前端 Base64 编码 |
+| `V8.Base64.decode(value)` | 前端 Base64 解码 |
+| `V8.Base64.isValid(value)` | 判断字符串是否为有效 Base64 |
+| `V8._` | Underscore 实例，如 `V8._.where(...)` |
+| `V8.Action.GetDateTimeNow()` | 兼容的前端全局时间函数 |
+| `V8.AddSysLog(...)` | 前端发起系统日志记录；不得含秘密 |
+| `V8.SendSystemMessage(...)` | 发送站内系统消息 |
+| `await V8.Method.ScanCode()` | 扫码；成功值同时写入 `V8.ScanCodeRes` |
+| `V8.Print.*` | TSPL/CPCL/ESC-POS 蓝牙标签与小票打印，兼容 GP-M322、CC4，见蓝牙打印参考 |
+| `V8.Identity.GetCapabilities()` | 读取当前租户强身份能力和本人登记状态 |
+| `V8.Identity.CreateActionHash(value)` | 为稳定业务命令生成 SHA-256 摘要 |
+| `V8.Identity.RegisterPasskey(options?)` | 登记当前用户 Passkey |
+| `V8.Identity.Verify({Purpose,ActionHash,Method,Code?})` | 完成 Passkey、Authenticator TOTP 或严格人脸验证并取得一次性后端票据；Totp 需 6 位 Code |
+
+扫码应优先接收 Promise 返回值；兼容代码可在调用后读取 `V8.ScanCodeRes`。
+`V8.Identity` 是强身份验证模块。`V8.Identity.Verify` 的成功结果不能直接授权业务；后端必须重读权威数据、重算摘要并调用 `V8.Method.ConsumeIdentityVerificationTicket`。
+蓝牙打印完整 API 包含 `V8.Print.createNew`、`V8.Print.createNewESC`、
+`V8.Print.OpenBluetoothPage`、`V8.Print.isConnected`、
+`V8.Print.reconnect`、`V8.Print.getConnectionState`、`V8.Print.subscribeConnection`、
+`V8.Print.getPrinterProfile`、`V8.Print.setPrinterProfile`、
+`V8.Print.prepareSend`、`V8.Print.Send`、`V8.Print.setOneTimeData`、
+`V8.Print.setPrinterNum`、`V8.Print.disconnect` 和
+`V8.Print.BLEInformation`。其中 `Send` 依赖 `prepareSend` 设置的共享分包游标，
+只作内部状态机入口；业务代码必须调用并 `await prepareSend`。当前挂载范围、连接
+真实性、佳博原 TSPL 回归、CC4 CPCL 适配、Android SPP 与串行约束见
+[`bluetooth-print.md`](../../v8-frontend-events/references/bluetooth-print.md)，TSC/ESC
+完整方法见
+[`bluetooth-print-api.md`](../../v8-frontend-events/references/bluetooth-print-api.md)。
+
+## 主前端源码帮助对象
+
+`DiyCommon.GetApiBase()` 是 `Microi.Client` 主前端源码内部取得 API 根地址的帮助
+方法，不属于租户前端 V8 的稳定公开对象。V8 代码优先使用受控 `V8.Http` 和
+`V8.SysConfig.ApiBase`；MicroService 从宿主数据读取 `apiBase`，不要假设子应用
+全局存在 `DiyCommon`。

package/skills/v8-utilities/references/platform-http-routes.md

@@ -1,83 +1,83 @@
-# Microi 平台 HTTP 路由索引
-
-本索引用于识别中文官网示例中的平台路由。路由可用不等于当前用户有权限；始终
-传当前租户 `OsClient`，使用受支持的 Token/访问密钥，并让服务端重新做菜单、
-表单、字段和数据范围校验。
-
-## 接口引擎
-
-| 路由 | 用途 |
-|---|---|
-| `POST /apiengine/{ApiEngineKey}` | 推荐的稳定接口引擎入口 |
-| `POST /api/ApiEngine/Run` | 仅旧客户端兼容，Body 传 `ApiEngineKey`；新增固定业务禁止使用 |
-| `/apiengine/{ApiEngineKey}--OsClient--{OsClient}--` | 仅用于确实无法设置 Header/Form/Query 的 GET/HEAD 场景 |
-
-普通请求优先在唯一 `osclient` Header 传租户，也可在 Query/Form/JSON 中冗余；
-固定业务必须使用真实引擎动态地址或唯一 `ApiAddress`，使日志、流量、审计和限流
-直接按引擎归因；旧通用入口只能由显式 `RunLegacy` 调用。
-不要无脑把特殊租户后缀加到每条 URL。官网中的
-`/apiengine/test1`、`/apiengine/get-product-list`、打印、支付和 Excel demo
-都是业务 `ApiEngineKey` 示例，不是固定平台接口。
-
-## FormEngine
-
-标准 Controller 路由：
-
-| 路由 | 用途 |
-|---|---|
-| `POST /api/formengine/GetTableData` | 查询列表 |
-| `POST /api/formengine/GetFormData` | 查询单条 |
-| `POST /api/formengine/AddFormData` | 新增 |
-| `POST /api/formengine/UptFormData` | 更新 |
-| `POST /api/formengine/DelFormData` | 删除 |
-| `POST /api/formengine/UptFormDataByWhere` | 按条件更新 |
-| `POST /api/formengine/DelFormDataByWhere` | 按条件删除 |
-| `POST /api/formengine/GetTableDataAnonymous` | 表配置允许时匿名查列表 |
-| `POST /api/formengine/GetFormDataAnonymous` | 表配置允许时匿名查单条 |
-| `POST /api/formengine/AddFormDataAnonymous` | 表配置允许时匿名新增 |
-
-动态路由还支持
-`/api/formengine/{operation}-{FormEngineKey}`（兼容无连字符操作名与连字符操作名）。
-访问密钥只需获得相应表/页面和 `form:read` 等作用域，不应把每个动态 URL 加入
-无条件白名单。完整调用模型见 `v8-formengine-http`。
-
-## 文件、消息、验证码与诊断
-
-| 路由 | 用途与边界 |
-|---|---|
-| `GET /api/Captcha/getCaptcha` | 获取验证码图片；同时保存响应 `captchaid` |
-| `POST /api/Captcha/Recognize` | 受控验证码识别，主要供采集引擎 |
-| `POST /api/HDFS/Upload` | 受限文件上传；优先用平台 SDK/V8 Upload |
-| `POST /apiengine/platform-private-file-url` | 获取当前租户短期私有文件地址；必须携带权威资源上下文 |
-| `GET /api/HDFS/OpenPrivateFile` | 受权打开私有文件/Office 代理 |
-| `POST /api/DiyChat/SendSystemMessage` | 发送站内消息；前端优先 `V8.SendSystemMessage` |
-| `POST /apiengine/platform-mq` | MQ 管理入口；Body 使用 `Action=Send`，仅当前租户超级管理员 |
-| `GET /apiengine/platform-service-health?OsClient={OsClient}` | 新版客户端固定匿名健康契约；返回 `Data.Status=Healthy`，新二进制同时返回真实后端版本；应用包先发布时版本可暂时为空，但健康结论不失败；不查询业务表 |
-| `GET /api/Diagnostics/health` | 旧节点滚动升级兼容健康路由；新版客户端不以它作为主要契约 |
-| `GET /api/Diagnostics/liveness` | 进程存活检查，不代表已就绪接流量 |
-
-`/api/example`、`/api/example/1` 仅用于说明 `V8.Http` 的普通 Controller 地址，
-不属于 Microi 固定接口。
-
-## 管理与内部交付接口
-
-下列路由不是普通业务 SDK：
-
-| 路由 | 限制 |
-|---|---|
-| `POST /api/DiyField/UptDiyFieldList` | 开发设计字段批量保存；需设计权限 |
-| `POST /api/FormEngine/ImportDiyTableRow` | 表格/子表导入；后端复核字段、外键和权限 |
-| `POST /api/SysUser/GetSysUserPassword` | 仅存量 DES 密码的超级管理员兼容查看；必须审计，访问密钥/普通角色拒绝 |
-| `POST /api/V8Engine/UploadApplicationAssetStream` | 管理员应用文件分片流式上传 |
-| `POST /api/V8Engine/FinalizeApplicationStreamPublish` | 校验清单并原子切换应用版本 |
-
-应用流式发布必须使用 MCP/平台发布流程：文件逐个校验 SHA-256，版本目录不可变，
-同一应用用跨节点锁串行，入口文件最后切换。不得把这两个内部路由包装成匿名上传。
-
-## 安全检查
-
-- URL 不携带长期 Token、密码、连接串、私钥或 Redis 凭据。
-- 动态表名、ApiEngineKey、文件路径和 redirect 都先走白名单/授权。
-- 匿名路由只对明确开启的表或接口生效，仍要限流、限大小并做业务校验。
-- 管理接口必须核验当前租户与管理员身份，写后回读；超时先回读，不能盲目重试。
-- 示例 URL 中的租户、表 Key、接口 Key 和 Id 都是占位值，不复制为生产常量。
+# Microi 平台 HTTP 路由索引
+
+本索引用于识别中文官网示例中的平台路由。路由可用不等于当前用户有权限；始终
+传当前租户 `OsClient`，使用受支持的 Token/访问密钥，并让服务端重新做菜单、
+表单、字段和数据范围校验。
+
+## 接口引擎
+
+| 路由 | 用途 |
+|---|---|
+| `POST /apiengine/{ApiEngineKey}` | 推荐的稳定接口引擎入口 |
+| `POST /api/ApiEngine/Run` | 仅旧客户端兼容，Body 传 `ApiEngineKey`；新增固定业务禁止使用 |
+| `/apiengine/{ApiEngineKey}--OsClient--{OsClient}--` | 仅用于确实无法设置 Header/Form/Query 的 GET/HEAD 场景 |
+
+普通请求优先在唯一 `osclient` Header 传租户，也可在 Query/Form/JSON 中冗余；
+固定业务必须使用真实引擎动态地址或唯一 `ApiAddress`，使日志、流量、审计和限流
+直接按引擎归因；旧通用入口只能由显式 `RunLegacy` 调用。
+不要无脑把特殊租户后缀加到每条 URL。官网中的
+`/apiengine/test1`、`/apiengine/get-product-list`、打印、支付和 Excel demo
+都是业务 `ApiEngineKey` 示例，不是固定平台接口。
+
+## FormEngine
+
+标准 Controller 路由：
+
+| 路由 | 用途 |
+|---|---|
+| `POST /api/formengine/GetTableData` | 查询列表 |
+| `POST /api/formengine/GetFormData` | 查询单条 |
+| `POST /api/formengine/AddFormData` | 新增 |
+| `POST /api/formengine/UptFormData` | 更新 |
+| `POST /api/formengine/DelFormData` | 删除 |
+| `POST /api/formengine/UptFormDataByWhere` | 按条件更新 |
+| `POST /api/formengine/DelFormDataByWhere` | 按条件删除 |
+| `POST /api/formengine/GetTableDataAnonymous` | 表配置允许时匿名查列表 |
+| `POST /api/formengine/GetFormDataAnonymous` | 表配置允许时匿名查单条 |
+| `POST /api/formengine/AddFormDataAnonymous` | 表配置允许时匿名新增 |
+
+动态路由还支持
+`/api/formengine/{operation}-{FormEngineKey}`（兼容无连字符操作名与连字符操作名）。
+访问密钥只需获得相应表/页面和 `form:read` 等作用域，不应把每个动态 URL 加入
+无条件白名单。完整调用模型见 `v8-formengine-http`。
+
+## 文件、消息、验证码与诊断
+
+| 路由 | 用途与边界 |
+|---|---|
+| `GET /api/Captcha/getCaptcha` | 获取验证码图片；同时保存响应 `captchaid` |
+| `POST /api/Captcha/Recognize` | 受控验证码识别，主要供采集引擎 |
+| `POST /api/HDFS/Upload` | 受限文件上传；优先用平台 SDK/V8 Upload |
+| `POST /apiengine/platform-private-file-url` | 获取当前租户短期私有文件地址；必须携带权威资源上下文 |
+| `GET /api/HDFS/OpenPrivateFile` | 受权打开私有文件/Office 代理 |
+| `POST /api/DiyChat/SendSystemMessage` | 发送站内消息；前端优先 `V8.SendSystemMessage` |
+| `POST /apiengine/platform-mq` | MQ 管理入口；Body 使用 `Action=Send`，仅当前租户超级管理员 |
+| `GET /apiengine/platform-service-health?OsClient={OsClient}` | 新版客户端固定匿名健康契约；返回 `Data.Status=Healthy`，新二进制同时返回真实后端版本；应用包先发布时版本可暂时为空，但健康结论不失败；不查询业务表 |
+| `GET /api/Diagnostics/health` | 旧节点滚动升级兼容健康路由；新版客户端不以它作为主要契约 |
+| `GET /api/Diagnostics/liveness` | 进程存活检查，不代表已就绪接流量 |
+
+`/api/example`、`/api/example/1` 仅用于说明 `V8.Http` 的普通 Controller 地址，
+不属于 Microi 固定接口。
+
+## 管理与内部交付接口
+
+下列路由不是普通业务 SDK：
+
+| 路由 | 限制 |
+|---|---|
+| `POST /api/DiyField/UptDiyFieldList` | 开发设计字段批量保存；需设计权限 |
+| `POST /api/FormEngine/ImportDiyTableRow` | 表格/子表导入；后端复核字段、外键和权限 |
+| `POST /api/SysUser/GetSysUserPassword` | 仅存量 DES 密码的超级管理员兼容查看；必须审计，访问密钥/普通角色拒绝 |
+| `POST /api/V8Engine/UploadApplicationAssetStream` | 管理员应用文件分片流式上传 |
+| `POST /api/V8Engine/FinalizeApplicationStreamPublish` | 校验清单并原子切换应用版本 |
+
+应用流式发布必须使用 MCP/平台发布流程：文件逐个校验 SHA-256，版本目录不可变，
+同一应用用跨节点锁串行，入口文件最后切换。不得把这两个内部路由包装成匿名上传。
+
+## 安全检查
+
+- URL 不携带长期 Token、密码、连接串、私钥或 Redis 凭据。
+- 动态表名、ApiEngineKey、文件路径和 redirect 都先走白名单/授权。
+- 匿名路由只对明确开启的表或接口生效，仍要限流、限大小并做业务校验。
+- 管理接口必须核验当前租户与管理员身份，写后回读；超时先回读，不能盲目重试。
+- 示例 URL 中的租户、表 Key、接口 Key 和 Id 都是占位值，不复制为生产常量。