最佳休息 API 实践：是否包含状态

Question

例如，让我说我有一个 API，它返回一个数组中的多个对象，这些对象具有统计...就像

[{status:good},...,{status:good}]

应用程序逻辑说，如果其中的每个对象都具有“好”状态，则该数组是“好”的。当然。

所以，现在我通过我的 API JSON 编码返回该数组。我应该像这样将状态直接插入到 API 输出中吗

{status:good, array:[{status:good},...,{status:good}]}

或者我应该在客户端做。

API 设计时如何判断这种情况？有没有类似指导方针的东西？ 我的意思是第一种方法更直观，而第二种方法更便宜。

Answer 1

最重要的问题是您的 API 用于什么用途？通过添加额外的“摘要”状态，您正在对数据进行反规范化，这本身就是一个巨大的话题。

如果它对用户有所帮助，并且优先考虑的是让您的 API 快速且易于使用，那么将其包含在内，使 API 易于使用，特别是如果它可以减少重复调用的需要。

如果优先考虑数据完整性和大量数据使用而不是易用性，则不要包含摘要。