哪种网址模式更好?

时间:2014-01-17 13:46:06

标签: api rest restful-url

我正在建立一个外部的restfull api。这个api的目标是公开对象和计算统计数据。

例如,我们公开了订单清单和订单总量。

我在几种模式之间犹豫不决:

  • /命令/总金额
  • /命令/统计/总金额
  • /统计/命令/总金额

或者你可能有更好的主意吗?

当然,有几个对象和其他几个统计数据。这只是一个例子

感谢您的帮助!

2 个答案:

答案 0 :(得分:1)

没有一个正确的答案 - 这完全取决于你的其他API。例如......

/ stats / orders / totalamount - 如果您的API提供了大量统计信息,统计信息非常重要,并且您提供的信息不仅仅是订单

,那么这是有意义的

/ orders / stats / totalamount - 如果您在订单上提供不同的统计数据,并且不提供有关其他事物的统计数据,则有意义

/ orders / totalamount - 如果这是唯一的此类项目,则有意义。

从用户的角度考虑API中的重要实体。我认为订单将是最重要的实体。

答案 1 :(得分:1)

我更喜欢/orders/stats/stats/orders并将totalamount作为JSON结果的属性之一

原因是totalamount只是一个简单的值,它实际上只是统计结果的一部分。

/ orders / totalmount没有多大意义,除非你有很多方面来表示这个值。