问REST的JSON响应中是否应该包含空值？

EN

最近在API-Craft上对此进行了讨论。普遍的共识是，省略一个值与包含一个空值之间可能存在语义上的区别。

如果您的特定用例没有获得语义值，那么我要说的是查看API的目标使用者，并考虑忽略该值是否会给他们带来问题。

没有明显的赢家。由于没有，客户永远不应该在技术上依赖于这方面的任何约定，客户不应该期望这两种形状。

• 删除空值以减少带宽使用通常是不合理的(除非空字段的数量很大，并且带宽明显受损)。
• 删除空值以使人类读者更容易地看到实际值通常是不正确的，APIs不是人机界面。
• 保持空值以让人类读者更容易地看到文档结构通常是不合理的，API不是人机界面，API响应也不是API文档。
• 保持空值以允许脏客户机以通常不合理的特定方式解析json，因此客户端应该干净地写成宽容的读取器。
• 只在相应的创建方法(POST/PUT)需要显式传递空的情况下才保留空值，但通常很难实现。
• 当每个文档都有自己的客户端时，将输出与创建期间的请求保持相同的可能是有意义的，但通常很难实现。
• 需要考虑的一个特殊情况是，由?fields=foo,bar之类的东西触发的部分响应，其中返回所有其他字段的空值似乎有点违背直觉。