以下清单用于“上线前自检”:帮助你把幂等、标识保存、错误处理与安全边界做完整,避免上线后靠临时排障硬撑。
尚在选择路径时,请先看 选择接入路径、API 规范与接入评估 与 快速开始。
提示上线的最低标准
- 至少打通一条真实请求,并能稳定复现与排障。
- 能明确处理鉴权/权限失败与请求体失败(不是“失败就重试”)。
- 把关键标识保存下来:
request_id/trace_id/idempotency_key。
推荐阅读
上线前的四个检查面
上线前应已完成
- 已打通至少一条真实请求。
- 已能处理 Bearer、权限与返回结构。
- 已能区分同步
200和异步202。
基础链路
- 稳定生成或保存
request_id、trace_id、idempotency_key。 - 所有请求统一走公开入口与白名单路由。
- 前台、插件或中间层不要依赖未公开的 URL。
请求构造
- 能稳定发送
text;复杂上下文使用structured_input。 - 清楚
adminbearer 何时需要key_id。 - 如携带中性协议对象用于审计或翻译,仍放在
structured_input,不将其当作默认顶层请求结构。
返回与失败处理
- 能处理同步
200与异步202。 - 保存同步
output、usage_applications、可选exact_bridge,以及异步 workflow 标识与 URLs。 - 对 admission failure 有明确重试与回退规则。
- 只使用响应返回的 workflow URL 继续处理,不自行拼接 URL。
运维与排障
- 本地日志能按
request_id或trace_id追踪。 - 异步 workflow 引用不会丢失。
- 团队知道多数早期错误来自鉴权、scope、请求体校验与幂等策略,而不是业务逻辑本身。
推荐阅读