如何使用资源层次结构设计Restful API？

Question

有产品和产品评论。 所以，我可以获得这样的产品清单...

GET /products

我也可以获取一种产品或评论或类似的产品...

GET /products/{productID}
GET /products/{productID}/reviews

那些很清楚。 但是，当我想获得我撰写的所有评论时，就会发生问题。 我可以这样创建uri。

1. GET /products/reviews?author=myId

要么

2. GET /reviews?author=myID

但是，第一个问题来自{productID}与评论之间的冲突。 下一个问题来自关系产品和评论，因为评论应根据层次结构位于产品之下。

如何获得我使用RESTful API编写的所有评论？

Answer 1

通常路线是这样的

GET / products /：product_id / reviews？author = myID

所以参数是-product_id-作者

这样，您将获得特定产品和作者的所有评论。

不过，如果您需要所有评论，那么这是正确的：

GET / reviews？author = myID

Answer 2

要获得给定作者针对所有产品撰写的所有评论，一种RESTful的方式是

GET /作者/ {authorId} /评论

如果要获得给定作者针对单个产品撰写的所有评论，则可以使用

（a）GET / authors / {authorId} / products / {productId} / reviews

我喜欢这种方法，而不是在查询字符串中指定productId或authorId。 作者包含产品，产品包含评论，所以这是一个不错的RESTful URL。 但是，如果要使用查询字符串，则可以使用以下任一方法：

（b）GET / products / {productId} / reviews？authorId = {authorId}

（c）GET / authors / {authorId} / reviews？productId = {productId}

但是我个人更喜欢选项（a）而不是选项（b）或（c）。 我认为它以更简洁的方式描述了对象层次结构。

Answer 3

如果您是我，我将使用第二个，因为平面URI通常比分层URI短，并且较短的URI更易于路由：更难于误输入URI模板。

所以用

• GET /reviews?author={myID}
• GET /reviews?product={productID}

也可以 （如果您使用不同的评论类型，则最好使用product-reviews而不是仅reviews 。）

只是为了避免造成误解，REST没有URI结构约束，这些是实现细节，因此您可以同时使用建议的URI。 您应该记录它们并应用HATEOAS约束。