RESTful Web 服务 - 寻址



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

REST 架构中的每个资源由其 URI(统一资源标识符)标识。一个 URI 具有以下格式 -

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

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

构造标准 URI

设计 URI 时,需要考虑以下重要事项 -

  • 使用复数名词 - 使用复数名词来定义资源。例如,我们使用 users 来标识 users 作为资源。

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

  • 使用小写字母 - 尽管 URI 不区分大小写,但最好只将 url 保持为小写字母。

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

  • 使用 HTTP Verb - 始终使用像 GET、PUT 和 DELETE 这样的 HTTP Verb 来对资源进行操作。最好不要在 URI 中使用操作名称。

示例

下面是一个获取用户的较差 URI 的示例。

https://127.0.0.1:8080/UserManagement/rest/UserService/getUser/1 

下面是一个获取用户的良好 URI 的示例。

https://127.0.0.1:8080/UserManagement/rest/UserService/users/1
广告