如果我的JSON响应有一个额外的元素，我会创建一个新版本的REST API吗？

Question

我是设计REST API的新手，所以请原谅我对此事的无知。如果我在现有的JSON响应中添加一个新元素，是否意味着我需要为该REST api提供新版本？

Answer 1

这取决于您如何定义版本方案。

如果你有一个主版本和次版本的详细版本号，那么每当有些事情发生改变时就增加它是很好的，这样你就可以参考。在大多数情况下添加一个字段应该是向后兼容的，所以递增一个小版本号应该没问题。

但是到目前为止，我所见过的大多数Web API都只定义了主要版本，只有在存在非向后兼容更改时才增加，在这种情况下，我不会增加它。

如果您正在编写适当的文档，您可以始终清楚地说明什么构成了没有版本颠簸的情况下可能发生的非重大更改。