Web 前端开发

RESTful必须知道的那些事

2018-03-10  本文已影响0人  magicwager

为什么会出现RESTful

先不要急着知道RESTful到底是什么,它没那么高深的。要想清楚的知道RESTful,首先回顾下HTTP协议,以及API(Application Programming Interface,应用程序编程接口)。这样可以知道RESTful的来历及意义所在。

HTTP协议工作于客户端-服务端架构为上。浏览器作为HTTP客户端通过URL向HTTP服务端即WEB服务器发送所有请求。Web服务器根据接收到的请求后,向客户端发送响应信息。这里就涉及到HTTP请求Request)和响应(Response),对于一个完整的请求(Request)、响应(Response)来说,还是有一定规范的(有套路的),这里我们看一下HTTP请求和响应的一些基本信息。

举个栗子:

我们用Fiddler抓了一下360浏览器的任务中心的API接口信息,如下是它的请求信息:

GET http://task.browser.360.cn/online/setpoint HTTP/1.1
Accept: */*
User-Agent: Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)
Pragma: no-cache
Content-Type: application/x-www-form-urlencoded
Host: task.browser.360.cn
Content-Length: 449
Cookie:__guid=91251416.3523784108665864700.1520256100246.427D%25PO%25QR%25P9%25R1%25P0%25RS%25O5%25P4%25PO%25N7%25

得到的服务器响应结果,如下所示:

```
HTTP/1.1 200 OK
Server: nginx/1.6.3
Date: Sat, 10 Mar 2018 03:37:00 GMT
Content-Type: text/html; charset=utf-8
Transfer-Encoding: chunked
Connection: close
{"errno":"10003","errmsg":"\u7b7e\u540d\u9519\u8bef"}
    ```

我们可以看到:

那么问题来了,既然HTTP协议是有其规则的,那么我们在设计API的时候,也应该有一定的规则。这里头最有名的就是RESTful API规范了。

RESTful为何物?

首先来解释下它的直面意思,它是Representational State Transfer的缩写,翻译过来就是“表现层状态转换”。(直面意思都这么高深的样子)其实这里省略了它的主语resource(资源),即resource representational state transfer(资源表现层状态转换)。那资源指的又是什么呢?表现层又是什么?状态转化是做了什么呢?

我们知道客户端操作是通过HTTP请求对服务端资源操作的,HTTP/1.1中,请求方法有(GET, POST, PUT, PATCH, DELETE)这些,并且有具体的含义。

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

介绍上面基本概念后,总结下RESTful到底是什么,它就是:利用HTTP的请求方法去操作URL定位的资源,它是一种客户端与服务端交互的一种规范。它的核心思想就是:URL只负责描述需要操作的资源,所以URL里头不应该有动词,应该是名词。HTTP负责描述操作。

RESTful示例

例如一个关于组织机构的API设计应该这样:

http://www.organization.com/orgs
http://www.organization.com/departments
http://www.organization.com/staffs

基于请求的方式和路径来作为常见的CURD(增删改查)

GET /orgs 列出所有组织
POST /orgs 新增一个或多个组织
GET /orgs/ID 查询某个组织
PUT /orgs/ID 更新某个组织
DELETE /orgs/ID 删除某个组织
GET /orgs/ID/departments 查询某个组织下的所有部门
DELETE /orgs/ID/departments/ID/staffs 查询某个组织下的某个部门的所有员工

对于请求后的响应结果,RESTful也做了一个很好得定义:

GET /orgs:返回资源对象的列表(数组)
GET /orgs/resource:返回单个资源对象
POST /orgs:返回新生成的资源对象
PUT /orgs/resource:返回完整的资源对象
DELETE /orgs/resource:返回一个空文档

RESTful设计误区

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

RESTful优点

RESTful的缺点

上一篇 下一篇

猜你喜欢

热点阅读