用于检索对象集基数的REST API

时间:2014-06-16 14:19:19

标签: api rest

设计REST API的良好实践表明应该使用:

  • GET请求选择对象(或对象集合)
  • POST请求创建新对象

取自here的一对例子:

  • GEThttps://example.org/api/v1/zoos选择所有动物园
  • POSThttps://example.org/api/v1/zoos创建了一个新动物园

现在,所有这些方法都旨在检索实例(或一组实例)或修改某些实例状态。

如何检索存储在服务器上的那些资源的某些统计信息(例如,存储在服务器上的动画数量)? 我不希望有什么需要我下载整个集合然后计算文档的数量。不过,我不确定什么是正确的语法。如下:

https://example.org/api/v1/zoos/number

这样做的正确方法?如果没有,这是最好的做法?

1 个答案:

答案 0 :(得分:3)

根据我的经验,REST API通常由{Resource} / {Action} / {Parameter}隔离。

我建议使用:

/zoos/count

count告诉我您要对zoos资源做些什么。