在 API 响应中包含空字段是否被视为重大更改？

Question

我已更改 API 的行为（以前不包含空字段）以包含空字段。我被告知这是一个重大更改，但找不到有关此主题的可靠文档。

这是否被视为重大变更？

例如，之前会返回如下响应的 API：

{
  "key1": "value1"
}

现在返回还包含空字段的响应：

{
  "key1": "value1",
  "key2": null
}

Answer 1

包含空字段并不是重大更改。重大变化是现在出现了“一些”新领域。这对于前端开发人员来说可能是意想不到的，因为他们不知道会有哪些字段。

作为一个好的做法，请始终发送所有字段。如果有字段为空值，那就这样吧，没问题。但如果前端有接口或映射、出现或消失的字段，这可能是一个问题。