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

Question

例如，让我说我有一个API，该API返回数组中具有固定状态的多个对象。

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

应用程序逻辑说，如果其中的每个对象的状态为“良好”，则此数组为“良好”。 当然。

因此，现在我通过API JSON编码返回该数组。 我是否应该将状态直接插入API输出中，就像这样

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

还是应该在客户端执行

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

Answer 1

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

如果可以帮助用户并且优先考虑的是使您的API快速且易于使用，则将其包括在内，使该API易于使用，尤其是在可以减少重复调用的情况下。

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