上一主题: 管理模式下一主题: 操作模式


管理器模式

每个资源类型均有一个管理器模式接口。 此接口负责创建、读取、更新和删除 (CRUD) 此类型的实例。 URL 模式是将资源类型名称变为复数。 例如,gridsnetworks

使用 POST 操作可创建某一类型的实例。 POST 适用于管理器 URL 并定义资源类型的有效负载。 例如,要创建网格,请使用组成网格记录的有效负载对 /grids 执行 POST 操作。

使用 DELETE 操作可删除某一资源类型的实例。 要删除的 URL 包括资源类型的唯一标识符(ID、名称等)。 例如,DELETE /grids/govt_sales 将删除名为 govt_sales 的网格。

可使用 GET 读取资源类型的实例。 此操作将返回包含实例的列表。

按照上述管理模式中所述的类似方式,通过对包含实例标识符的 URL 执行 PUT 操作并使用代表已更改属性和资源类型的有效负载可更新实例。

对于不希望在一次更新中指定整个列表的类型,管理器模式还可应用于该类型内部的列表属性。 例如,可以不使用 PUT grids/admin 与包含已填充整个可用网格 ID 列表的网格记录,转为使用管理器模式,方法是利用以下 URL 对单个网格参数发出其中一个 CRUD 调用:

admin/grids/availableGridIds

此 URL 模式还可用于影响类型实例的关系。 例如,对网格记录中的 servers 属性执行 POST 操作可将服务器(由服务器记录有效负载指定)添加到网格中,而以同样方式执行 DELETE 操作可将其删除。

示例目标 1

BFC/<resource_type>s 
GET

检索此管理器管理的实例。

返回值:资源记录列表。

POST

创建由管理器管理的实例。

有效负载:资源记录。

返回值:实例名称。

结果:将创建的实例添加到现有受管资源。

示例目标 2

BFC/<resource_type>s/<instance id> 
GET

检索 URL 标识的实例。

返回值:单个资源记录。

PUT

更新:更新实例。

有效负载:包含要设置的属性的稀疏记录。

返回值:正常。

结果:更新资源。

POST

创建到资源的连接或资源的子资源。

有效负载:资源记录(稀疏,例如仅包含 ID 或完全填充的子组件定义)。

返回值:实例标识符。

结果:将资源连接到资源实例或为资源实例创建资源。

DELETE

删除资源,或撤消 URL 中资源标识的关系。

有效负载:N/A。

返回值:正常。

结果:从现有受管资源或资源关系中删除实例。