上一主题: 设计模式下一主题: 管理器模式


管理模式

BFC API 中的类型可具有用于设置配置数据的可选管理接口。 URL 模式为 admin/<resource_type>s(例如,admin/grids)。

在配置适用于指定类型的所有实例时,使用此 URL 模式。 规定细粒度配置(例如,特定的网格)时,管理模式还可应用于资源实例。 通过将目标资源的 ID 添加到 URL 中来完成范围控制:

admin/<resource_type>/<resource_id>

例如:

admin/grids/mygrid

配置数据集固定后,可使用 GET 返回记录。

在管理目标具有多个配置值时,支持通过查询字符串获取配置值的动态列表。 这使得客户端能够更加灵活地确定要从服务器提取的数据。 以下为 URL 示例:

admin/grids?keys=backboneid,licensekey 

要设置配置值,您可以使用 PUT。

另外,利用管理接口,可通过对包括密钥的 URL(例如,admin/grids/backboneControllerId/admin/discovery)执行 PUT 操作并使用一个或多个更新值的有效负载来设置特定的配置值。

要清除配置值,请使用 PUT 和相应记录中的 null 值。 也可以使用 DELETE 与 URL 中的密钥(例如,admin/grids/licensekeyadmin/backboneId)。

示例目标 1

BFC/admin/<resource_type>s,
BFC/admin/<resource_type>/<resource_id>

GET

检索与 resource_type 或资源相关的配置。

返回值:配置记录。

PUT

替换配置。

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

返回值:正常。

结果:更新稀疏记录中的值。

示例目标 2

BFC/admin/<resource_type>s/<parameter>,
BFC/admin/<resource_type>/<resource_id>/<parameter> 

GET

检索命名参数的配置值。

查询字符串:N/A。

返回值:配置值。

PUT

替换配置值。

有效负载:新的配置值。

返回值:正常。

结果:更新指定配置参数的值。

DELETE

删除:指定配置参数的值。

有效负载:N/A。

返回值:正常。

结果:取消设置指定配置参数的值。