简述对REST，RESTFUL，RESTFUL API的认识

刺骨的言语ヽ痛彻心扉 2023-08-17 16:47 122阅读 0赞

##  简述对REST，RESTFUL，REST API的认识 ##

--------------------

## 一、REST风格 ##

1.  **REST的起源**

REST这个词，是Roy Thomas Fielding在他2000年的博士论文中提出的。Fielding是一个非常重要的人，他是HTTP协议（1.0版和1.1版）的主要设计者、Apache服务器软件的作者之一、Apache基金会的第一任主席。所以，他的这篇论文一经发表，就引起了关注，并且立即对互联网开发产生了深远的影响。

他这样介绍论文的写作目的：

> “本文研究计算机科学两大前沿----软件和网络的交叉点。长期以来，软件研究主要关注软件设计的分类、设计方法的演化，很少客观地评估不同的设计选择对系统行为的影响。而相反地，网络研究主要关注系统之间通信行为的细节、如何改进特定通信机制的表现，常常忽视了一个事实，那就是改变应用程序的互动风格比改变互动协议，对整体表现有更大的影响。我这篇文章的写作目的，就是想在符合架构原理的前提下，理解和评估以网络为基础的应用软件的架构设计，得到一个功能强、性能好、适宜通信的架构。”  
> (This dissertation explores a junction on the frontiers of two research disciplines in computer science: software and networking. Software research has long been concerned with the categorization of software designs and the development of design methodologies, but has rarely been able to objectively evaluate the impact of various design choices on system behavior. Networking research, in contrast, is focused on the details of generic communication behavior between systems and improving the performance of particular communication techniques, often ignoring the fact that changing the interaction style of an application can have more impact on performance than the communication protocols used for that interaction. My work is motivated by the desire to understand and evaluate the architectural design of network-based application software through principled use of architectural constraints, thereby obtaining the functional, performance, and social properties desired of an architecture. )

1.  **REST的认识**

Fielding将他对互联网软件的架构原则，定名为REST，即Representational State Transfer的缩写，直接的翻译是"表现层状态转移"。

REST 从资源的角度来观察整个网络，分布在各处的资源由URI确定，而客户端的应用通过URI来获取资源的表示方式。获得这些表示方式致使这些应用程序转变了其状态。随着不断获取资源的表示方式，客户端应用不断地在转变着其状态，所谓表现层状态转移（Representational State Transfer）。

这一观点不是凭空臆造的，而是通过观察当前Web互联网的运作方式而抽象出来的。Roy Fielding 认为，“设计良好的网络应用表现为一系列的网页，这些网页可以看作的虚拟的状态机，用户选择这些链接导致下一网页传输到用户端展现给使用的人，而这正代表了状态的转变。”

REST是设计风格而不是标准。REST通常基于使用HTTP，URI，和XML以及HTML这些现有的广泛流行的协议和标准。  
（1）资源是由URI来指定。  
（2）对资源的操作包括获取、创建、修改和删除资源，这些操作正好对应HTTP协议提供的GET、POST、PUT和DELETE等方法。  
（3）通过操作资源的表现形式来操作资源。  
（4）资源的表现形式则是XML或者HTML，取决于读者是机器还是人，是消费web服务的客户软件还是web浏览器。当然也可以是任何其他的格式。

## 二、RESTFUL结构 ##

如果一个架构符合REST原则，就称它为RESTful架构。要理解RESTful架构，最好的方法就是去理解Representational State Transfer这个词组到底是什么意思，它的每一个词代表了什么涵义。

> REST 从资源的角度来观察整个网络，分布在各处的资源由URI确定，而客户端的应用通过URI来获取资源的表示方式。获得这些表示方式致使这些应用程序转变了其状态。随着不断获取资源的表示方式，客户端应用不断地在转变着其状态，所谓表现层状态转移（Representational State Transfer）。

1.  **资源（Resources）**

REST的名称"表现层状态转化"中，省略了主语。“表现层"其实指的是"资源”（Resources）的"表现层"。

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

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

1.  **表现层（Representation）**

“资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层”（Representation）。比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。

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

1.  **状态转化（State Transfer）**

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

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

客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。  
（1）GET（SELECT）：从服务器取出资源（一项或多项）。  
（2）PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。  
（3）POST（CREATE）：在服务器新建一个资源。  
（4）DELETE（DELETE）：从服务器删除资源。

还有三个不常用的HTTP动词。  
（1）HEAD：获取资源的元数据。  
（2）OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。  
（3）PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。

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

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

1.  **综述**

综上所述，我们总结一下什么是RESTful架构：  
（1）每一个URI代表一种资源；  
（2）客户端和服务器之间，传递这种资源的某种表现层；  
（3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

## 三、RESTFUL WEB API ##

RESTFUL WEB 服务（也称为 RESTFUL WEB API）是一个使用HTTP并遵循REST原则的Web服务。

RESTFUL WEB API有一些主要注意的地方：

1.  **URI不能包含动词**

因为"资源"表示一种实体，所以应该是名词，URI不应该有动词，动词应该放在HTTP协议中。

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

1.  **接口版本管理**

（1）应该将API的版本号放入URL

http://api.example.com/app/1.0/foo

（2）将版本号放在HTTP头信息中

http://api.example.com/app/foo
    
    Accept: version=1.0

但是将版本号放在HTTP头信息中，不如放入URL方便和直观。

参考：  
1.[http://www.ruanyifeng.com/blog/2014/05/restful\_api.html][http_www.ruanyifeng.com_blog_2014_05_restful_api.html]  
2. [https://www.cnblogs.com/springyangwc/archive/2012/01/18/2325784.html][https_www.cnblogs.com_springyangwc_archive_2012_01_18_2325784.html]

[http_www.ruanyifeng.com_blog_2014_05_restful_api.html]: http://www.ruanyifeng.com/blog/2014/05/restful_api.html
[https_www.cnblogs.com_springyangwc_archive_2012_01_18_2325784.html]: https://www.cnblogs.com/springyangwc/archive/2012/01/18/2325784.html