谈一谈Restful接口设计风格

一、前言

本文介绍后台接口设计风格——Restful风格，分为四个部分，第二部分解释一个Restful的中文意思，并给出要真正理解Restful风格，就要从它的中文名一个个拆开去理解；第三部分将Restful中文名 “资源的表现层状态转化”，拆分为三个词语，一个个理解；第四部分，介绍Restful设计风格的具体要求；第五部分，罗列两个在使用Restful风格的错误。

二、Restful是什么意思？

REST，英文全称 Representational State Transfer ，译为"表现层状态转化"。

如果一个架构符合REST原则，就称它为RESTful架构。

注意：实际应用中，Restful只是一种接口设计风格，如果一个接口的url和参数符合REST原则，就称它为RESTful设计风格，如果一个接口的URL和参数不符合REST原则，就称它不符合RESTful设计风格，但是并不能说它错了，对于一个后台接口来说，只要功能可以正常使用，URL和参数的设计没有固定法则，只是不符合Restful风格而已，仅仅如此。

要理解RESTful架构，最好的方法就是去理解Representational State Transfer这个词组到底是什么意思，它的每一个词代表了什么涵义。如果你把这个名称搞懂了，也就不难体会REST是一种什么样的设计。

注意：Restful仅仅是一种风格而已，与语言无关，可以使用XML格式定义，也可以使用JSON格式定义。

三、从名称上去彻底理解Restful风格

3.1 资源（Resources）

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

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

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

3.2 表现层（Representation）

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

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

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

3.3 状态转化（State Transfer）

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

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

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

四、Restful风格到底是什么？

综合上面的解释，我们总结一下什么是RESTful设计风格：

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

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

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

注意：Restful仅仅是一种风格而已，与语言无关，可以使用XML格式定义，也可以使用JSON格式定义。

五、在使用Restful风格的时候犯下的几种错误

RESTful架构有一些典型的错误。

5.1 URI包含动词

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

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

如果某些动作是HTTP动词表示不了的，你就应该把动作做成一种资源。比如网上汇款，从账户1向账户2汇款500元，错误的URI是：

POST /accounts/1/transfer/500/to/2

注意：只是说这个接口的uri这样写不符合Restful风格，仅仅是不符合Restful风格而已，并不是说这个接口错了。

正确的写法是把动词transfer改成名词transaction，资源不能是动词，但是可以是一种服务：

POST /transaction HTTP/1.1
Host: 127.0.0.1from=1&to=2&amount=500.00

5.2 URI中加入版本号

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

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

注意：只是说这个接口的uri这样写不符合Restful风格，仅仅是不符合Restful风格而已，并不是说这个接口错了。

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

Accept: vnd.example-com.foo+json; version=1.0Accept: vnd.example-com.foo+json; version=1.1Accept: vnd.example-com.foo+json; version=2.0

六、尾声