【问题标题】:REST API for retrieving object set cardinality用于检索对象集基数的 REST API
【发布时间】:2014-06-16 14:19:19
【问题描述】:

设计 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

这样做的正确方法?如果不是,最佳做法是什么?

【问题讨论】:

标签: api rest


【解决方案1】:

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

我推荐使用:

/zoos/count

count 告诉我你想用zoos 资源做什么。

【讨论】:

  • 我同意这种做法
  • 请注意此处的措辞。 URI 应该是一个“事物”,而不是一个动作。因此,也许/Zoos/stats/count 会更好。 stats 就像 Zoos 资源的元资源,我们正在访问特别是 count 资源。也可能有 /Zoos/stats/last_update/Zoos/stats/admin 等。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2019-03-14
  • 1970-01-01
  • 2020-05-24
  • 2021-09-08
相关资源
最近更新 更多