RESTful三问

2021-11-04 10:52:03

我觉得学习一个技术，其实就是要弄明白三件事情：是什么（what），为什么（why），怎么用（how）。正是所谓的三W方法。

所以打算总结一个“三问”系列。为了自己学习，也分享给别人。

RESTful是什么？

REST是REpresentational State Transfer的缩写。但是representational state transfer仍然很难理解。直译的话一般译作表述性状态转移。什么鬼？
其实是因为前面主语被去掉了，应该是Resource Representational State Transfer。直译的话，我觉得可以译作“资源的具象化的状态转移”。仍然是什么鬼？
这只是我的个人理解。因为这个本来就是老外的晦涩难懂的论文中的词汇，并没有一个准确的翻译。
 
那么什么是资源的具象化的资源状态转移呢？
Resource：资源，即数据。
网络上的所以数据都可以被看做是资源，并且能用一个唯一的URL表示。比如一条用户信息数据，一张图片，一个文件等等。
Representational：具象化的。
URL就像资源的ID，让资源在网络上有了统一的定位能够被获取和访问。那么资源在网络上怎么描述呢，或者说资源的表现形式是什么？
我们有MIME media types，比如image/jpeg，multipart/encrypted，text/plain等等，来规定资源如何展现。
有HTTP中的具体动词方法：GET，POST，PUT，PATCH，DELETE等等，来规定对资源的操作。
这些都可以认为是资源的representations。
State Transfer：状态转移。
我们知道HTTP协议是无状态的。但是资源是有状态的。
比如有一个资源是ID为9527的员工，age是32岁。这都是资源的状态。state transfer就是资源的状态通过网络来传递转移。比如我通过操作把这个员工age变为33岁，就是状态转移。
 
现在假设网络上有一个资源，URL是localhost:8080//root/users。是一组用户数据。
我通过HTTP的GET方法（representational）请求这个资源localhost:8080//root/users（resource），然后得到的返回（transfer）是用application/json表示的（representational）这组用户的数据（state）。
就是一次资源的具象化的状态转移。
我再通过PATCH - localhost:8080//root/users/9527 - {age:33} 把这个指定用户的新状态发送给服务器端的这个资源来进行状态更新，就是又一次的resource representational state transfer。
 
如果你还是没看懂（应该是没有），那可以自行参考大神Roy Fielding的毕业论文。REST就是他提出的。这哥们参与设计HTTP协议，也是Apache Web Server项目的co-founder。
 
怎么样，看完是不是更懵了呢？
没关系，一句话理解就是：在HTTP请求中，用URL定位资源，用HTTP动词（GET,POST,PUT,PATCH,DELETE）描述对资源进行什么操作。
符合这种设计风格的架构设计，我们就称之为RESTful风格的架构。

为什么要用RESTful？

首先要说明的一点就是，RESTful是一种设计风格，不是指导思想，也不是最佳实践。只是有些情况下选用符合RESTful的架构确实更好一些。不吹不黑。

现在的网络时代，技术飞速发展。SOA啦，Web Service啦，微服务啦，各种概念各种思想层出不穷。客户端也是浏览器，Android，iOS等都五花八门。

那么在前后端分离的思想下，一般我们都是设计基于 HTTP API 的服务。这样的好处是什么呢？当然是一套API各种客户端随便用啦。

设计API的时候，我们一般有两种方法：

一种是只要用 GET 请求和 POST 请求就足够了，把操作放在URL上。

一种是RESTful的方式，URL只表示资源，用HTTP中不同的请求方法代表不同的操作。

假设有一类资源 ResourceXYZ ，对其有增删查改的操作。 如果只使用 GET POST 之类的设计方式，那么很可能会设计以下的请求接口：

POST .../addResourceXYZ //新增资源

POST .../delResourceXYZ  //删除资源

GET .../getResourceXYZ?resourceId=resourceId  //获取指定ID的资源

POST .../updateResourceXYZ  //更新资源

如果按照 RESTful 的 设计方式，很可能会设计以下的请求接口：

POST .../ResourceXYZs  //新增资源

DELETE .../ResourceXYZ/{resourceId}  //删除资源

GET .../ResourceXYZ/{resourceId}  //获取指定ID的资源

PUT .../ResourceXYZ/{resourceId}  //更新资源

那么使用RESTful风格有什么好处呢？

现在假设，客户端要获取该资源，其 ID 为 resourceId 。 如果成功，那么一切都好说。 如果失败， Restful 的处理方式是，通过 HTTP status 返回错误码来表示原因，例如 404 表示该资源不存在。

那么只用 GET POST 两种方法的方式呢？ 响应请求

GET .../getResourceXYZ?resourceId=resourceId

的时候能不能也用 404 呢？

按照 404 的语义，响应 404 是不对的： 因为客户端请求的 URL 实际上是正确的，只是对应的参数没有找到对应的结果。很多时候，就只能靠响应 200 然后返回空数据或者空对象来处理了。例如 Content-type 为 application/json 时，可以返回 {} 或者

{

    "error": "not found",

    "code": 404

}

这样就会要求客户端，必须处理 HTTP 回复的具体内容，而不能只处理头部。 那么客户端要怎么处理这个 json 呢？要先解析 json ，然后尝试区分这是一个资源的内容，还是一个错误提示。

这样前端的人就比较容易骂街了。

如何设计一个RESTful的架构呢？

我觉得这篇写的很详细很好了，这里全文转载阮一峰的RESTful API 设计指南。

以下为转载开始：

一、协议

API与用户的通信协议，总是使用HTTPs协议。

二、域名

应该尽量将API部署在专用域名之下。



https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。



https://example.org/api/

三、版本（Versioning）

应该将API的版本号放入URL。



https://api.example.com/v1/

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

四、路径（Endpoint）

路径又称"终点"（endpoint），表示API的具体网址。

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

  • https://api.example.com/v1/zoos
  • https://api.example.com/v1/animals
  • https://api.example.com/v1/employees

五、HTTP动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

  • GET（SELECT）：从服务器取出资源（一项或多项）。
  • POST（CREATE）：在服务器新建一个资源。
  • PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
  • PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
  • DELETE（DELETE）：从服务器删除资源。

还有两个不常用的HTTP动词。

  • HEAD：获取资源的元数据。
  • OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

下面是一些例子。

  • GET /zoos：列出所有动物园
  • POST /zoos：新建一个动物园
  • GET /zoos/ID：获取某个指定动物园的信息
  • PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
  • PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
  • DELETE /zoos/ID：删除某个动物园
  • GET /zoos/ID/animals：列出某个指定动物园的所有动物
  • DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

六、过滤信息（Filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。

  • ?limit=10：指定返回记录的数量
  • ?offset=10：指定返回记录的开始位置。
  • ?page=2&per_page=100：指定第几页，以及每页的记录数。
  • ?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
  • ?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

七、状态码（Status Codes）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

  • 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
  • 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
  • 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
  • 204 NO CONTENT - [DELETE]：用户删除数据成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
  • 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
  • 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
  • 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
  • 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
  • 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
  • 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

状态码的完全列表参见这里。

八、错误处理（Error handling）

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。



{

    error: "Invalid API key"

}

九、返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范。

  • GET /collection：返回资源对象的列表（数组）
  • GET /collection/resource：返回单个资源对象
  • POST /collection：返回新生成的资源对象
  • PUT /collection/resource：返回完整的资源对象
  • PATCH /collection/resource：返回完整的资源对象
  • DELETE /collection/resource：返回一个空文档

十、Hypermedia API

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。



{"link": {

  "rel":   "collection https://www.example.com/zoos",

  "href":  "https://api.example.com/zoos",

  "title": "List of zoos",

  "type":  "application/vnd.yourformat+json"

}}

上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。

Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。



{

  "current_user_url": "https://api.github.com/user",

  "authorizations_url": "https://api.github.com/authorizations",

  // ...

}

从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user，然后就得到了下面结果。



{

  "message": "Requires authentication",

  "documentation_url": "https://developer.github.com/v3"

}

上面代码表示，服务器给出了提示信息，以及文档的网址。

十一、其他

（1）API的身份认证应该使用OAuth 2.0框架。

（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

转载结束。

支持RESTful的Java开发框架，有SpringMVC，Oracle的Jersey等。关于Jersey我还在学习，以后会写专门的文章来总结。

参考文章：

知乎用户覃超的回答：https://www.zhihu.com/question/28557115/answer/48094438

V2EX用户noli的文章：https://www.v2ex.com/t/340607?p=2

阮一峰的博客：http://www.ruanyifeng.com/blog/2014/05/restful_api

上一篇：JavaScript跨域请求和jsonp请求实例


下一篇：将bloomfilter(布隆过滤器)集成到scrapy-redis中