文档
历史档案候选与单体方案快照接口能力

产品接入与版本约定

页面动作如何成为可实现和可验证的接口需求

历史方案:本页为恢复第一版多仓文档前的快照,不是现行任务或已实现能力。现行入口为平台架构

每个页面操作的接口记录

记录:需求 ID、产品、触发动作、用户身份、请求端点、对象归属、输入/输出、失败和重试语义、上游版本、验证证据。路径已有而权限或状态不符时仍是待适配,不标“已完成”。

示例:Console 创建 Key → 本人登录会话 → 上游 Token 创建接口 → 返回可追踪 Key 记录 → 显示成功或参数/权限错误。实际字段由上游请求结构确定。

兼容与聚合

合适的接口可直接消费;确有登录交接、数据聚合或协议差异时再增加 BFF。BFF 不另存权威余额、不用管理员凭据绕过客户权限、不让客户端任意指定付款用户。

公共模型协议与管理 API 分别维护;有破坏性改变时提供升级路径和新旧兼容测试。客户端类型由固定 Schema 生成或明确维护,不要求先发布旧 Contracts 包才能开始本地验证。

重试和错误

按接口分别定义可安全重试的条件;稳定操作 ID 只有在后端持久去重时才提供幂等保证。区分输入错误、未登录、无权限、额度不足、限流、提交未知、供应故障和内部错误;面向客户的错误不暴露供应商密钥或内部栈。

文档验收

每个对外示例在声明版本运行;覆盖至少一个成功和相关失败场景;原型 mock 与真实响应分开;文档中的“支持”必须对应实际测试范围。

On this page