理解restful 架构 && RESTful API设计指南

　　restful是前端和后端接口中都会使用的设计思想。

　　网站即软件，我们也常说的webapp，这种互联网软件采用的是“客户端/服务器”模式，建立在分布式体系上。 网站开发，也可以完全采用软件开发的模式，但是传统上软件和网络还是不同的领域，因为： 软件开发主要针对单机环境，而网络是研究系统之间的通信。 互联网的兴起，使得这两个领域开始融合，现在我们开始考虑，如何开发在互联网环境中使用的软件。

• RESTful架构，就是目前最为流行的一种互联网软件架构，它结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用。 

RESTful架构作者

　　REST这个词，是Fielding提出的。 他是HTTP协议（1.0和1.1）的主要设计者，Apache服务器软件的设计者之一、Apache基金会的第一任主席。

　　REST作者fielding是这样介绍的： REST是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能强、适宜通信的架构。

RESTful名称

　fielding将他对互联网软件的架构原则，定名为REST，即Representational State Transfer（表现层状态转化）的缩写。 如果一个架构符合REST原则，就说是RESTful架构。

　如果我们想要理解RESTful架构到底是怎样的，我们就要去理解Representational State Transfer 这个词， 只有每一个词都知道是什么意思，才能更好的理解REST是一种怎样的设计。

　　

资源

　　REST的名称‘表现层状态转化’中，省略了主语，表现层实际上指的是‘资源’的表现层。

　　所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。

　　所谓"上网"，就是与互联网上一系列的"资源"互动，调用它的URI。

表现层（Representation）

"资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层"（Representation）。

比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。

URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的".html"后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴，而URI应该只代表"资源"的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。

状态转化（State Transfer）

　　访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。

　　互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。

　　客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

综述

　　综合上面的解释，我们总结一下什么是RESTful架构：

　　（1）每一个URI代表一种资源；

　　（2）客户端和服务器之间，传递这种资源的某种表现层；

　　（3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

RESTFUL设计误区

　　RESTful架构有一些典型的设计误区。

　　最常见的一种设计错误，就是URI包含动词。因为"资源"表示一种实体，所以应该是名词，URI不应该有动词，动词应该放在HTTP协议中。

　　举例来说，某个URI是/posts/show/1，其中show是动词，这个URI就设计错了，正确的写法应该是/posts/1，然后用GET方法表示show。

　　另一个设计误区，就是在URI中加入版本号。

　　http://www.example.com/app/1.0/foo
　　http://www.example.com/app/1.1/foo
　　http://www.example.com/app/2.0/foo

　　因为不同的版本，可以理解成同一种资源的不同表现形式，所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分。

RESTful API

　　网络应用程序，分为前端和后端两个部分。 当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备...）。

　　因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。 这导致API构架的流行，甚至出现‘API First’的设计思想。 RESTful API是目前比较成熟的一套互联网应用程序的API设计。

协议

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

域名

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

https://api.example.com

　我们经常可以看到类似的api作为开头的域名。

　如果api很简单，我们可以放在主域名下面：

https://example.org/api/

　比如最常见的就是图灵机器人的api接口：

http://www.tuling123.com/openapi/api?key=20ff1803ff65429b809a310653c9daac

版本

　　应该讲api的版本号放在url中。

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

　　

另一种做法是将版本号放在http头信息中，但是不如放在url中直观方便。github采用这种方法。

路径

　　路径又称为‘终点’，表示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：删除某个指定动物园的指定动物

　　

过滤信息

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

　　下面是一些常见的参数。

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

　　实际上这些也就是get请求中我们传递的参数了，包括limit限制条数，offset限制开始位置等等都是我们常用的一些请求参数用于过滤。

状态码

　服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。即状态码是后台根据情况写好发送给前端的，400、200、404等等都是如此。 状态码还是需要正确书写的，这样有利于前端准确判断出现的问题是属于前端还是后端。

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

错误处理

　　如果状态码是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"
}

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

https://api.github.com/