【问题标题】:How to design a Restful API with the resource hierarchy?如何设计具有资源层次结构的 Restful API?
【发布时间】:2012-06-22 08:39:30
【问题描述】:

有产品和产品评论。 所以,我可以得到这样的产品列表......

GET /products

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

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

这些很清楚。但是当我想获得我写的所有评论时,问题就出现了。 我可以像这样创建 uri..

1. GET /products/reviews?author=myId

或

2. GET /reviews?author=myID

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

如何获取我使用RESTful API 撰写的所有评论?

【问题讨论】:

    标签: rest uri restful-url


    【解决方案1】:

    通常路线是这样的

    GET /products/:product_id/reviews?author=myID

    所以参数是 - product_id - 作者

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

    不过,如果您想要所有评论,那么这是正确的:

    GET /reviews?author=myID

    【讨论】:

      【解决方案2】:

      要获取给定作者为所有产品撰写的所有评论,实现此目的的 RESTful 方式是

      GET /authors/{authorId}/reviews

      如果您想获取给定作者为单个产品撰写的所有评论,那么您可以使用

      (a) 获取 /authors/{authorId}/products/{productId}/reviews

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

      (b) 获取 /products/{productId}/reviews?authorId={authorId}

      (c) 获取 /authors/{authorId}/reviews?productId={productId}

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

      【讨论】:

        【解决方案3】:

        如果我是你,我会使用第二个,因为平面 URI 通常比分层 URI 短,而且较短的 URI 更容易路由:更难意外输入 URI 模板。

        所以使用

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

        也可以。 (如果您有不同的评论类型,也许最好使用product-reviews 而不是reviews。)

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

        【讨论】:

          猜你喜欢
          • 1970-01-01
          • 1970-01-01
          • 1970-01-01
          • 2014-11-10
          • 1970-01-01
          • 1970-01-01
          • 2013-02-21
          • 1970-01-01
          • 1970-01-01
          相关资源
          最近更新 更多