API 错误码规范与诊断清单（2025）
# API 错误码规范与诊断清单（2025）
统一错误码与诊断流程让跨团队协作更高效。
## 一、结构与分类
- 结构：`code`/`message`/`traceId`/`details`。
- 分类：客户端/服务端/依赖错误细分与范围编码。
## 二、诊断与重试
- 诊断清单：必采集字段与上下文、用户影响与复现路径。
- 重试与退避：按错误类别设定可重试策略。
## 三、观测与告警
API设计与开发
API 限流与熔断的设计与实现
从算法到工程实践系统总结 API 限流与熔断的实现策略，结合监控与告警，构建可降级的稳态系统。
API 限流与请求签名（HMAC、时间窗与防重放）
结合令牌桶/漏桶限流与HMAC请求签名, 通过时间窗与Nonce复用检测实现防重放与审计, 并提供服务端/客户端实现与验证流程。
API分页与游标设计最佳实践
为高数据量与高并发场景设计可靠分页，采用游标与稳定排序、限制偏移与窗口，提供一致性与性能策略与验证方法。
API分页与资源耗尽治理（游标/限制/速率）最佳实践
构建可验证的API分页治理策略，采用游标分页与最大页大小限制，协同速率限制与Backpressure，附参数校验与响应头示例。
API安全日志与可观测性（Trace-ID与脱敏）最佳实践
统一API安全日志与可观测性方案，包含Trace-ID注入与传播、采样与速率限制、PII脱敏与统一日志Schema，附中间件与审计示例。
API安全测试与Fuzz策略最佳实践
构建可验证的API安全Fuzz方案，包含Schema驱动的输入生成、边界值与变异策略、速率限制与重放能力、审计与简易覆盖统计，附执行器与样例。
API安全防护：WAF、Bot管理与速率限制
通过 WAF 规则与 Bot 管理、速率限制与配额策略构建 API 安全防线，抵御滥用与攻击。
API幂等与去重：Idempotency-Key与去重表实践
通过幂等键与去重表保障至少一次投递下的正确性，减少重试与网络抖动带来的副作用。
API幂等性Key与去重最佳实践
设计并实现API幂等性Key与服务端去重逻辑，提供可验证的请求头与数据库约束方案，保障重试安全与一致性。
API幂等性设计：Idempotency-Key与去重治理
通过 Idempotency-Key 与请求签名建立幂等保障，配合唯一约束与去重窗口实现安全重试与一致响应。
API弃用与迁移治理（Deprecation/Sunset/Warning）最佳实践
通过标准化的弃用与下线通知头、迁移指引与宽限期策略，规范API生命周期管理并降低迁移成本。
API授权Scope最小权限治理（层级/匹配）最佳实践
通过层级化Scope与资源-动作匹配、最小权限原则与拒绝默认策略，统一治理API授权并降低越权风险。
API版本治理与媒体类型协商最佳实践
通过媒体类型与Accept头进行版本协商，统一默认与最大版本策略，按路由映射返回对应版本的响应，并在不支持时返回406，附解析与选择示例。
