16、RESTful 资源命名与表示设计指南

RESTful 资源命名与表示设计指南

1. RESTful 服务基础

RESTful 网络服务通过资源来公开其数据和算法。通常存在一种层次结构，从顶层开始，逐渐分支到无数的叶子节点。例如，行星列表包含各个行星，行星包含地理点和地点，地点又包含地图；S3 存储桶列表包含单个存储桶，存储桶包含对象。

将算法作为一组资源进行公开需要一定时间来掌握。我们需要从关注动作（如“在地图上搜索地点”）转变为关注动作的结果（如“符合搜索条件的地图上的地点列表”）。如果设计不符合 HTTP 的统一接口，可能需要重新审视这一步骤。

2. 资源命名

• 根 URI 设定 ：将网络服务的根设定为 http://maps.example.com/ 。为简洁起见，有时会使用相对 URI，它们都相对于该根 URI。
• URI 设计规则 ：
  1. 使用路径变量编码层次结构 ：例如 /parent/child 。
  2. 在路径变量中使用标点符号避免暗示不存在的层次结构 ：例如 /parent/child1;child2 。
  3. 使用查询变量表示算法的输入 ：例如 /search?q=jellyfish&start=20 。