api - 在RESTful API中汇总数据

Question

有一个有趣的HTTP API问题，我想对此发表一些意见。我的API允许人们以1-10的等级对事物进行评分。我有一个GET /ratings端点，列出了用户的评分。我们还想要一种显示用户每天的平均评分的方法。所以我的问题是-摘要应该是相同的URL，例如/ratings?data=summary，还是它自己的URL，例如/ratingsummaries或/ratings/summary？

通常情况下，我认为没有正确的答案。摘要是否只是评级的另一种观点，在这种情况下，摘要将是评级资源并且应属于/ratings？或者，评级摘要是它自己的资源，在这种情况下，它应该拥有自己的网址，例如/ratingsummaries？ /ratings/summary看起来也不错，但它实际上不是评级的子资源。

期待您的反馈意见。谢谢大家！

Answer 1

我的观点是，只要您重新获得评级列表，就可以像/ratings/这样使用它。搜索参数通常以@QueryParam的形式给出。例如ratings?offset=20&records=50&startDate=xx&endDate=yy

/ratings/{id}/表示由ID标识的特定等级。

/ratings/{id}/votes以获得评分的投票。

评级摘要与评级是不同的实体，因此它是separte网址的候选
/ratingsummary?startDate=x&endDate=y
或者您的路径可以以/ratingsummary开头；它可以像/ratingsummary/ratings?offset=20&records=50&startDate=xx&endDate=yy
在这种情况下，您将获得评级摘要，然后可以向下钻取对摘要有贡献的评级列表，然后深入到一个特定的评级等。

遵循/entities/{idOfOneEntiity}/{attributeOfEntitiy}等模式是理想的。