api - 警告客户端有关已弃用的 REST API

Question

我们正在弃用 REST 服务，我们希望将此通知客户。遵循的最佳做法是什么？

我可以想到以下选项

将弃用警告消息作为服务响应 JSON/XML 的一部分传递

在 HTTP“警告”响应头中传递警告消息。

你能分享一下你的想法吗？

Answer 1

我不会更改状态代码或服务响应中的任何内容以向后兼容。我会在响应中添加一个“警告”标题。

Warning: 299 - "Deprecated API"

您还可以查看此(旧)回复: https://softwareengineering.stackexchange.com/questions/55081/deprecate-a-web-api-best-practices