首页 > 代码库 > 理解REST

理解REST

原文: http://spring.io/understanding/REST

2000年,RoyFielding在他的博士论文中引入和定义了REST(Representational State Transfer---表述性的状态传输)。REST是一种设计分布式系统的架构样式。它不是一个标准而是一组约束,例如无状态、客户/服务的关系、以及统一的接口。REST虽然不强制关联HTTP,但通常都跟HTTP匹配。

REST的原则

1. 使用容易理解的目录结构式的URIs来公开资源;

2. 使用JSON或XML所描述数据对象和属性来进行内容传输;

3. 显示的使用HTTP方法来传递消息(例如GET、POST、PUT和DELETE);

4. 无状态交互要求在请求之间,服务端不保存客户端的上下文环境。状态依赖限制要有可伸缩性。客户端保持会话状态。

HTTP方法

使用HTTP方法把CRUD(create、retrieve、update、delete)操作映射到HTTP请求中。

GET方法

用于检索信息。GET请求必须是安全和等幂的,所谓等幂是指不管使用相同的参数重复请求多少次,检索的结果都是相同的。它也会产生一些用户所不期望的副作用,因此不能执行关键的系统操作。请求也可以是部分或有条件的。

检索一个ID是1的addresses:

GET /addresses/1

POST方法

请求URI所指定的资源做一些与所提供的实体对象相关的一些事情。通常POST方法被用于创建一个新的实体对象,但也可以用于更新实体对象。

创建新的address

POST /addresses

PUT方法

把一个实体对象保存到指定URI位置。PUT方法可以创建一个新的实体对象或更新一个既存的实体对象。PUT请求是等幂的。等幂性是PUT与POST请求之间的主要差异。

使用ID为1的address:

PUT /addresses/1

注意:PUT方法会替换既存的实体对象。如果只提供了数据元素的一个子集,那么其余的部分会被设置为空或null所替代。

PATCH方法

这个方法仅用于更新URI指定的实体对象中指定的字段。PATCH请求是等幂的,等幂性是PUT和POST请求之间的主要差异。

PATCH /addresses/1

DELETE方法

该方法用于请求删除一个资源,但是该资源不会被立即删除。它可以是异步或长时运行的请求。

删除ID是1的address

DELETE /addresses/1

HTTP状态代码

状态代码指的是HTTP请求的结果。

1XX---信息性的

2XX---成功

3XX---重定向

4XX---客户端错误

5XX---服务端错误

媒体类型

HTTP请求头中的Accept和Content-Type能够被用于描述HTTP请求中要发送或请求的内容。如果客户端要请求一个JSON方式的响应,就可以把Accept设置为application/json。相反,在发送数据时,要把Content-type设置为application/xml,以便告诉客户端发送相关请求的数据时XML格式的。

理解REST