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

Question

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

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

取自 here 的一对示例:

• GET:https://example.org/api/v1/zoos 选择所有动物园
• POST:https://example.org/api/v1/zoos 创建一个新动物园

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

如何检索存储在服务器上的资源的一些统计信息(例如，存储在服务器上的动物园的数量)？ 我没想到需要我下载整个集合然后计算文档数量。不过，我不确定正确的语法应该是什么。如下:

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

正确的做法？如果不是，最佳实践是什么？

Answer 1

根据我的经验，REST API 通常按 {Resource}/{Action}/{Parameter} 分隔。

我建议使用:

/zoos/count

count 告诉我您想对 zoos 资源执行什么操作。