最佳休息API练习:是否包含状态

时间:2015-07-18 10:50:01

标签: json performance api rest

例如,让我说我有一个API,它返回一个有stati的数组中的几个对象...就像

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

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

所以,现在我通过我的API JSON编码返回该数组。我应该将状态直接插入API输出中,如此

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

或者我应该在客户端进行。

如何在API设计时决定此类案例?有没有类似指南的东西? 我的意思是第一种方法更直观,而第二种方法更便宜。

1 个答案:

答案 0 :(得分:2)

最重要的问题是您使用的API是什么?通过添加额外的“摘要”状态,您可以对数据进行去规范化,这本身就是一个很大的主题。

如果它对用户有帮助,那么优先考虑的是快速使用您的API易于使用然后包含它,使API易于使用,特别是如果它可以减少重复呼叫的需要。

如果优先级是数据完整性,而且数据使用量大于易用性,那么请不要包含摘要。