REST并显示需要用户输入的URI

时间:2016-01-25 13:33:43

标签: rest

我有一个与模型一起使用的REST服务。因此,一旦用户导航到模型,我就允许两个端点/ModelRootItems/Item

/Item端点需要模型中项目的ID,例如:/Item/1234

当用户访问模型时,我返回以下URI:

/Model/My_Model/ModelRootItems

/Model/My_Model/Item/{ItemID}

但是我觉得我不应该公开/Item URI,因为没有ID就不完整。用户可以通过我的帮助页面看到/Item端点存在。

在URI列表中显示此端点是对还是错?

1 个答案:

答案 0 :(得分:1)

在这种情况下,我认为没有正确/错误的选择。但是,我建议你使用

/Model/My_Model/Items

(请注意复数形式Items)以返回包含Model

所有项目的列表
/Model/My_Model/Items/{ItemID}

返回ID引用的单个Item。 请注意,这只是一个约定,正如我已经说过的,在这种情况下没有正确/错误的选择,特别是如果你使用REST的HATEOAS原则和不透明的URI。