资源的空嵌套属性的正确响应是什么

Question

在一个只返回 Json 的 API 上考虑这些端点：

• GET /cities/{id}/stores
• GET /cities/{id}/mayor

store 和 mayor 都是可以拥有自己的标量属性的对象。

city->stores 关系是一对多的，而city->mayor 关系是一对一的。在这两种情况下，结果都可以为空。

我同意

GET /stores/{id}、GET /cities/{id} 和 GET /mayors/{id} 在具有该 ID 的资源不存在时应返回 404。

但是，如果一个城市没有商店，那么我希望GET cities/{id}/stores 返回[]。

我的问题是，鉴于一个城市没有现任市长，应该怎么做？ GET /cities/{id}/mayor返回？

Answer 1

如果给定城市的市长未设置并且存在一对一关系，则应返回404状态码。

返回 null 值没有意义 - 因为 API 使用者不知道如何处理这个值。

另一种选择是将此端点从 mayor 更改为 mayors 并始终返回空集合或带有一个条目的集合-但这不是一个好主意，应该很好记录在案，总的来说，我很遗憾我提出了建议；）

您还可以将市长嵌入城市，然后在返回的 JSON 中将其值设置为 null（如果不存在）。