REST API设计和更改“契约”？

Question

我正在设计RESTful应用程序接口。结果将以JSON对象的形式出现。我不需要将POJO类中的所有字段都发送到客户端，因此我应该定义某种“契约”。

假设我有一个属性类，我为它定义了id、名称和地址。稍后，我可能希望将地址更改为geoData，而不影响客户端。

有什么优雅的方式(模式)可以做到这一点吗？

Answer 1

创建REST设计的版本控制。当您开始创建新的实现时，使用新的URI来定义它。例如，使用相似参数创建新的URI，但版本不同：

检索旧实现/ver1//user(仍在维护中)

• 新实现版本

通过这样做，客户端仍然能够检索具有旧实现的用户，而不会出现任何问题。但是，当您决定再次更改实现时，最好冻结旧版本的接口(例如，在实现v3接口时，您应该通知客户端不再支持旧的版本1API)。

更多信息可以在这里找到：

How to version REST URIs

Versioning restful services