java - 如何形成REST URL？

Question

我是 REST 新手，我正在查看一些示例。与 URL 形成混淆，假设我有两个不同的用例。

1) 我想显示所有可用的产品(在我的商店中)

 /app/version1/products  - this would give all products 
 /app/version1/products/1  - this would give product with id 1

2) 我想显示所有评分最高的产品

现在我的问题是，我的网址看起来像

 /app/version1/products/topratedProducts 

或

  /app/version1/topratedproducts 

哪个 URL 更可取？为什么？

谢谢

Answer 1

/app/version1/products  - this would give all products 
/app/version1/products/1  - this would give product with id 1

这两个 URL 看起来都不错并且引用了资源。

当您明确想要在产品列表中查找规范时，我建议使用查询参数。

示例:

/app/version1/products{?type}

示例网址:

/app/version1/products?type=TOP
/app/version1/products?type=AVERAGE

您在后端维护类型并支持获取不同类型的产品。

使用不同的 URL 可能会增加消费终点，但理想情况下，这只是列出的所有产品中的一个规范。