文档

Core / API Edge 接口需求总表

API 逐项需求、源码归属、字段与验收条件

本轮范围为 Core 与 API Edge 的接口需求,含固定 new-api 路由、供应网关排除清单与 OceanWay 新增差异。沿用第一版架构目录,不再只描述模块职责。版本 API-REQ-0.1:属于需求草案,源码已有、迁入计划、接口实现和运行验证分开记录。

覆盖范围

  • 固定源码中 387 个方法 + 路径:381 个静态/权限表注册,另 6 个 Host Protocol 注册;逐项有 Owner、请求/返回来源、身份、业务规则、重试和验收。
  • 上游两个 OpenAPI 共 199 项操作;其中 12 项未匹配固定注册,进入差异目录,不能直接算可用。
  • 新增 18 项内部或业务差异提案,与上游已有接口明确分开。
  • 运行时插件可以增加接口,需实际部署 manifest 才能列出该部署的全集;本次不虚构已安装插件,也不把各创作产品私有 CRUD 纳入已完成范围。

接口需求目录

Core/Edge 内部新接口 · OceanWay 业务差异 · 源码与规范差异

每个接口的完成定义

  1. 方法、路径、资源归属、调用方与实现仓明确。
  2. Path/Query/Header/JSON/表单、必填、类型、默认、范围、权限可写字段明确。OpenAPI 缺少 required 不能解读为运行时全部可选;数据库字段不能全部写入。
  3. 成功与错误 HTTP 状态、业务包络、返回结构、分页/时间/单位、流式或文件输出明确。
  4. 业务状态变化、副作用、重复调用、支付/任务幂等、取消与恢复规则明确。
  5. 原接口沿用、内部适配、业务扩展、网关保留、未实现占位分别标记。
  6. 逐项具备成功/边界/权限/失败/重复/并发场景与实际验证证据,才从“需求草案”进入“已支持”。

统一需求规则

路径与兼容:默认保留 new-api 方法、路径及字段,不为了分仓统一改名。路径参数名称与尾斜杠按源码记录;上游规范命名不同要映射,不静默改变 SDK。旧客户端不应被无理由强制新 Key 格式或全量新增必填 Header。

身份与权限:以注册时中间件加处理器为依据;匿名登录、支付回调和内部身份不能混为一类。客户 owner 从可信身份取得;员工权限按操作收敛。授权缓存明确撤销时限。取回完整客户 Key 的接口仅供其 owner,不等同供应凭证接口。

金额与计量:客户账务唯一 Writer 为 Core;请求单位、供应用量、积分、人民币分明确区分。价格按受理版本;退款/释放有可核验依据。消费、充值、预留、赠送和成本记录不能混用。

错误与 HTTP:已有管理接口可能以 HTTP 200 + success=false 表示业务拒绝,模型接口有各自 error 包络;沿用时记录真实行为,不武断重写全部状态码。新增接口补稳定机器码,未知执行状态不可伪装失败未收费。

分页/筛选:p/page_size、起止时间、模型/Key/类型过滤按每个处理器实际支持;列表与统计不能未经核对承诺同条件。任务/日志跨客户查询仅授予员工。

幂等与恢复:读取不增加消费;重复财务回调只入账一次。模型调用的幂等键绑定客户和请求摘要,未提供支持时不得承诺自动去重。网关响应不明、进程崩溃、SSE 中断先关联/核对原操作,不能自动退款后重发。

流式/文件/任务:保留协议事件顺序、结束和错误语义、背压与取消传播;不要求 Core 处理每个分片。文件大小、类型和对象授权要限制;任务提交、查询、取消意图、供应终态与客户结算分别建模。

字段完整性的真实状态

本次发现 200 项注册接口没有匹配 OpenAPI,152 项匹配接口没有响应 Schema;这些已逐项标记,不能把自动生成的观察字段当作完整冻结契约。登录、Key 创建/取回与日志统计的关键差异已人工核对。CE-02/03 应按当前优先级补齐缺口、复用原测试并进行真实兼容验证。

完整 JSON 台账 · 上游管理 OpenAPI · 上游模型 OpenAPI。源扫描工具记录在本机 coordination/tools,读取固定源码而不启动网关或修改业务数据库。

On this page