如果我的JSON響應有一個額外的元素，我會創建一個新版本的REST API嗎？

Question

我是設計REST API的新手，所以請原諒我對此事的無知。如果我在現有的JSON響應中添加一個新元素，是否意味着我需要爲該REST api提供新版本？

Answer 1

這取決於您如何定義版本方案。

如果你有一個主版本和次版本的詳細版本號，那麼每當有些事情發生改變時就增加它是很好的，這樣你就可以參考。在大多數情況下添加一個字段應該是向後兼容的，所以遞增一個小版本號應該沒問題。

但是到目前爲止，我所見過的大多數Web API都只定義了主要版本，只有在存在非向後兼容更改時才增加，在這種情況下，我不會增加它。

如果您正在編寫適當的文檔，您可以始終清楚地說明什麼構成了沒有版本顛簸的情況下可能發生的非重大更改。