RESTful Web 服务 - 寻址

寻址是指定位服务器上的一个或多个资源。这类似于定位某人的邮政地址。

REST 架构中的每个资源都由其 URI(统一资源标识符)标识。URI 的格式如下 −

<protocol>://<service-name>/<ResourceType>/<ResourceID>

URI 的目的是定位托管 Web 服务的服务器上的资源。请求的另一个重要属性是 VERB,它标识要对资源执行的操作。例如,在 RESTful Web 服务 - 第一个应用程序 一章中,URI 为 http://localhost:8080/UserManagement/rest/UserService/users,VERB 为 GET。

构建标准 URI

以下是在设计 URI 时需要考虑的重要事项 −

  • 使用复数名词 − 使用复数名词定义资源。例如,我们使用用户将用户标识为资源。

  • 避免使用空格 − 使用长资源名称时,请使用下划线 (_) 或连字符 (-)。例如,使用 authorized_users 而不是 authorized%20users。

  • 使用小写字母 − 尽管 URI 不区分大小写,但最好只使用小写字母来保留 URL。

  • 保持向后兼容性 − 由于 Web 服务是公共服务,因此一旦公开的 URI 应始终可用。如果 URI 更新,请使用 HTTP 状态代码 300 将旧 URI 重定向到新 URI。

  • 使用 HTTP 动词 − 始终使用 HTTP 动词(如 GET、PUT 和 DELETE)对资源执行操作。在 URI 中使用操作名称并不好。

示例

以下是获取用户的不良 URI 示例。

http://localhost:8080/UserManagement/rest/UserService/getUser/1

以下是获取用户的良好 URI 示例。

http://localhost:8080/UserManagement/rest/UserService/users/1