json - 来自 REST API 的 JSON 响应中是否应该包含空值？

Question

关闭。这个问题是 opinion-based .它目前不接受答案。

---

想要改进这个问题吗？ 更新问题，以便 editing this post 提供事实和引用来回答它.

关闭 3 年前。

Improve this question

我正在设计和开发一个 RESTful API。我对 API 采取了一种务实的、面向资源的方法(面向资源、统一接口(interface)、可寻址性，但没有真正的 HATEOAS)。我不确定的一点是如何处理对象中的空值。

我应该在 API 响应中包含具有空值的字段吗？

例子:

{
    "fieldA": "AAA",
    "fieldB": null
}

或者，如果系统没有这些字段的数据，我应该完全省略这些字段吗？

例子:

{
    "fieldA": "AAA"
}

Answer 1

最近在 API-Craft 上有一个关于这个的讨论。 .普遍的共识是，省略值与包含空值之间可能存在语义差异。

如果没有为您的特定用例获得语义值(value)，那么我会说看看您的 API 的目标消费者，并考虑省略该值是否会给他们带来问题。