警告客户端不推荐REST

Question

我们不推荐REST服务，我们想通知客户。所采用的最佳做法是什么？

我可以想到以下几种选择

1. 将弃用警告消息作为服务响应JSON/XML的一部分传递
2. 在HTTP“警告”响应头中传递警告消息。

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

Answer 1

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

Warning: 299 - "Deprecated API"

您还可以检查这个(旧的)响应：https://softwareengineering.stackexchange.com/questions/55081/deprecate-a-web-api-best-practices

Answer 2

IETF有一个“弃用HTTP报头字段”草案，它建议在服务器响应中添加特殊的headers。

示例

第一个示例显示了一个没有日期信息的弃用标头字段：

Deprecation: true

第二个示例显示了带有日期信息的弃用标头和后续版本的链接：

Deprecation: Sun, 11 Nov 2018 23:59:59 GMT
Link: <https://api.example.com/v2/customers>; rel="successor-version"

第三个示例显示了一个反推荐标头字段，其中包含后续版本和API的弃用策略的链接。此外，它还显示了不推荐的资源的日落日期：

Deprecation: Sun, 11 Nov 2018 23:59:59 GMT
Sunset: Wed, 11 Nov 2020 23:59:59 GMT
Link: <https://api.example.com/v2/customers>; rel="successor-version", <https://developer.example.com/deprecation>; rel="deprecation"