← 中文资源

简体中文版本

API 弃用与下线工作流

先公告弃用、输出 Deprecation 与 Sunset 头、度量剩余用量,待消费方迁移后再移除接口,避免静默中断。

阅读英文原文

概述

下线接口的风险在于你不知道谁还在用。先盘点消费方与用量,公告截止日期与迁移指南,并用响应头持续提醒与计数,直到用量归零或日期到期再移除,才能把中断变成可预期的过程。

关键步骤

  1. 盘点每个接口的消费方与当前用量。
  2. 公告弃用,给出日期与迁移指南。
  3. 输出 Deprecation 与 Sunset 头并持续计数。
  4. 用量归零或到期后下线接口。

验证

  • 下线前用量降至约定阈值。
  • 响应头出现在警告日志中。
  • 消费方按迁移指南完成切换。
  • 无未公告的中断被报告。

决策点

能否为个别消费方延期,取决于是否有书面例外与新的硬性日期;先限流再移除,可暴露隐藏的消费方。

适用范围

本条目围绕「API 弃用与下线工作流」给出可复制的步骤、验证方式与常见问题,适合需要按此流程落地的工程团队。执行时请结合自身上下文调整命令与阈值,并在变更前后留存证据,便于后续复核与回滚。

建议在正式环境落地前先在预发或隔离环境演练一遍,把关键观测指标与负责人一并记录,确保出现异常时能快速定位并恢复。

HTTP/1.1 200 OK
Deprecation: @1735689600
Sunset: Wed, 01 Jan 2026 00:00:00 GMT
Link: <https://docs.example.com/migrate>; rel="deprecation"