通过示例了解REST

时间:2010-05-01 16:18:45

标签: rest

我唯一真实地接触过REST的想法是通过Ruby on Rails'RESTful routing。这适合我使用Rails构建的基于CRUD的应用程序,但因此我对RESTfulness的理解有限。


假设我们有一个有限的Items集合,每个集合都有一个唯一的ID,以及许多属性,例如颜色,形状和大小(某些项目可能未定义)。

客户可以在一段时间内使用项目,但每个项目只能由一个客户端同时使用。对项目的访问由服务器管理。客户可以请求从服务器临时使用某些项目。

通常,客户只会对访问具有特定属性的多个项目感兴趣,而不是访问特定项目。

当客户端请求使用多个Items时,服务器会使用与请求相对应的ID列表进行响应,或者使用响应来响应所请求的项目当前不可用或不存在。

客户可以提出以下类型的请求:

  • 告诉我有多少绿色三角形项目(总数/可用数量)。
  • 让我使用200个大红色物品。
  • 我已完成第21,23,23项。
  • 添加100个新的红色方块。
  • 删除50个小绿色项目。
  • 将所有大黄色五边形项目修改为蓝色。

上面的玩具示例就像我最近必须处理的资源分配问题。我应该如何RESTful地思考它?

3 个答案:

答案 0 :(得分:6)

理解的诀窍是从关注名词而不是动词来思考问题。

在其他世界中,动词都是“预设”,名词变得无限灵活。在肥皂或大众世界中,动词是无限灵活的。限制你的想法,锁定动词,然后看看你需要什么名词来解决你的问题。

这正是darrel在上面的答案中所做的 - 他为一个满足你的约束的锁定了一个新名词,然后设置了对它们的访问以实现你想要的。

您的一些问题与搜索或过滤器相关 - 对于那些考虑资源类型的GET,传入查询参数来限制或过滤结果。

答案 1 :(得分:5)

如果在您的方案中锁定资源确实是一个域关注点,那么我建议将锁建模为资源。

以下是一些关于如何处理您建议的请求的建议。

GET /Triangle/Green/Count
GET /Triangle/Green/Available

POST /Item/Red/Large/Locks?quantity=200

DELETE /Item/21/Lock
DELETE /Item/23/Lock
DELETE /Item/25/Lock

POST /Square/Red?quantity=100

DELETE /Item/Green/Small?quantity=100

POST /Pentagon/Blue?url=/Pentagon/Yellow

话虽如此,定义URL有点无关紧要。使用适当的链接关系设计媒体类型是RESTful设计的关键部分。

答案 2 :(得分:0)

阅读本书以获取基本知识......我陷入了什么是REST ...... !!!

内容管理系统可能包含一组文章。这里有两个显然的资源。首先,有个别文章。每个构成一个资源。还有第二种资源:文章集。

要获取所有文章的列表,我们可以针对此集合发出HTTP GET请求,例如路径/文章。要获取单个资源的内容,我们必须识别它。 Rails的方式是给出它的主键值(即它的id)。我们再次发出一个GET请求,这次是针对URL / articles / 1。到目前为止,这一切看起来都很熟悉。但是当我们想要在我们的收藏中添加一篇文章时会发生什么?

在非RESTful应用程序中,我们可能会使用动词短语作为名称发明一些动作:articles / add_article / 1。在REST世界中,我们并没有这样做:我们应该告诉资源使用一组标准动词做什么。要使用REST在我们的集合中创建新文章,我们将使用针对/ articles路径的HTTP POST请求,其中包含要添加的文章的帖子数据。是的,这与我们用于获取文章列表的路径相同:如果您向其发出GET,它会以列表响应,如果您对其执行POST,则会向集合添加新文章。

更进一步。我们已经看到您可以检索文章的内容,针对路径/ articles / 1发出GET请求。要更新该文章,您将针对同一URL发出HTTP PUT请求。并且,要删除它,您可以再次使用相同的URL发出HTTP DELETE请求。