json - 从端点返回数据时的最佳实践？

Question

我和我的同事正在从头开始构建端点。到目前为止，我们的约定是像这样“标记”数据有效负载：

  users: {[...]}
  customers: {[...]}

但是，当个人user或被customer要求的情况下呢？他们是否应该被标记为：

  user: {...}
  customer: {...}

还是在这种情况下只返回对象是常见的约定？

标签： jsonasynchronous

Answer 1

您不应格式化所有端点响应以返回相同的结构。调用者应该知道期望的格式，因此使您的端点简洁且可重用比使所有有效负载具有相似的结构更重要。

实现 CRUD 端点是最常见的，它将返回单个记录/单个数据类型的记录数组。我不确定为什么在您的情况下您希望从同一个端点返回用户和客户，但这似乎是一个非常具体的、不可重用的端点。