java - REST api 中的版本控制资源

Question

我创建了一个公开为 Web 服务的应用程序。我正在尝试遵循 REST 原则。我正在使用 Spring 4。

到目前为止我所做的是创建我自己的 mime 类型 application/vnd.mycompany-v1+json。从访问 Web 服务的客户端，我说我想要哪个版本(目前只有一个)。

然而，这不是我需要做的全部。我还需要保留不同版本的资源，因为我可能会从一个版本到另一个版本添加/删除属性等。解决这个问题的方法是什么？您是否为每个版本创建一个包？

com.mycompany.web.resources.v1.Bike、com.mycompany.web.resources.v2.Bike 等？我猜这种方法会奏效，但在这个阶段不知道版本的数量，所以它可能是一个很大的重复列表。我不知道这是不是一个问题，或者它是否必须如此？

我想我不是第一个考虑对资源进行版本控制的人，那么这是如何处理的？

Answer 1

您应该通过在资源 url 中添加版本控制信息来保持不同的版本。类似于 http://yourserver/app/v1/..

你应该在你的 api 中包含版本控制的原因是一些客户端可能已经在使用你以前的版本并且不想升级。这更多是为了在您的 api 设计中增加灵 active 。当然，作为 api 提供者，您始终可以声明从现在开始您将不再支持版本 x。