RESTful架构,是目前最流行的一种互联网软件架构。它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。
REST是Representational State Transfer的缩写的缩写,翻译过来就是表现层状态转换。这里省略了主语Resources,它是资源的表现层。
资源
资源就是网络上的实体,可以用URI(统一资源定位符)指向它,要获取资源,访问它的rul就可以了。所谓"上网",就是与互联网上一系列的"资源"互动,调用它的URI。表现层
资源可以有多种表现形式,我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。URI只代表资源的实体,代表资源在网络的具体位置,不代表它的形式。它的具体表现形式,应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是对"表现层"的描述。状态转换
访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。
互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生"状态转化"(State Transfer)。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。综上所述,我们总结一下什么是RESTful架构:
(1)每一个URI代表一种资源;
(2)客户端和服务器之间,传递这种资源的某种表现层;
(3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"
RESTFUL API的设计
- API与用户的通信协议,总是使用http协议
- 应将api部署在专有域名之下,或主域名之下.如:
https://api.example.com
或者https://example.org/api/
- 每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,API中的名词应该使用复数。
- restful api直接使用http协议,所以它使用标准的http状态码
- 返回结果
- GET: 返回对象数组或单个资源对象
- POST: 返回新生成的资源对象
- PUT: 返回更新后完整的资源对象
- PATCH: 返回被修改的属性
- DELETE: 返回204状态码与空对象
- 如果状态码是4xx或5xx,就应该向用户返回出错信息。
- 如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。如limit、offset、sort_by、order、page、per_page等
大量参考阮一峰的RESTful API 设计指南