RESTful 规范

web 服务交互

我们在浏览器中能看到的每个网站,都是一个web服务器。那么我们在提供每个web服务的时候,都需要前后端交互,前后端交互就一定有一些实现方案,我们通常叫web服务交互方案。
目前主流的三种web服务交互方案:

  • REST (Representational State Transfer) 表征性状态转移
  • SOAP (Simple Object Access Protocol)简单的对象访问协议
  • XML-RPC (XML Remote Procedure Call)基于XML的远程过程调用

XML-RPC 是通过XML将调用函数封装,并使用HTTP协议作为传送机制。
后来在新的功能不断被引入下,这个标准慢慢演变成今日的SOAP协议。
SOAP服务则是以本身所定义的操作集来访问网络上的资源。
SOAP也是基于XML的,但是他不只限于HTTP协议的传输,包括TCP协议,UDP协议都可以传输。
REST是Roy Thomas Fielding博士与2000年在它的博士论文里提出来的。
REST相比SOAP更加简洁,性能和开发效率也有突出的优势。
现在越来越多的web服务开始采用REST风格设计和实现。
例如,amazon.com提供接近REST风格的Web服务进行图书查找;雅虎提供的Web服务也是REST风格的。

如果我们想要理解restful,就要理解Representational State Transfer 这个词组的意思,表征性状态转移(又译:表现层状态转化)。
这里说的表征性,其实就是指资源。通常我们称为资源状态转移。

什么是资源

任何事物,只要有被引用到的必要,它就是资源。
我们在浏览器中看见的文本,视频,图片等等都是资源。这些都是实实在在存在的实体。资源可以是一个实体,也可以是抽象的概念。
比如说:

  • 我的个人信息

  • “妳”的微信号(疯狂暗示)


    害羞
  • 你和我的潜在关系

在我们的网络中,我们要引用资源,资源一定要有一个标识,在web中的唯一标识就是URI,URI我们不经常听说,但我们却经常用URL,那两者区别是什么呢?

什么是URI,URL

URI 统一资源标志符
URlL统一组员定位符
URI 是给我们的资源进行标识的,URL是描述我们资源地址的。

比如说我们每个人都有名字和身份证,名字可能重名,但是身份证是唯一的,

那么身份证号就可以是我们的URI,标识我们每个人,也可以说标识我们每个资源。

你们可以通过身份证号锁定我,也可以通过下面这种方式锁定我.....

我的住址协议://地球/中国/屌丝省/屌丝市/幻想村/温柔乡/233号街道/233号/可笑的黑耀斑

这个就是我们的URL,我们通过这两种方式都可以找到我们的资源,

其实我们的URL可以说是URI的子集,通过定位的方式实现的URI。

这是我们资源的定位有了资源的地址后,我们要去访问资源,那么我们要通过什么方式去访问呢

统一在资源接口

现在我们可以通过URl去访问到资源,那么我们对资源会有很多不同的操作,增删改查,以前我们可能会为了这个增加新设计一个URL,然后这个URL就是对数据增加的,还会为了更新和删除分别设计一个URL,现在我们不用了,我们只有一个URL,然后根据HTTP请求方式的不同,对资源进行不同的操作,这个就是统一资源接口。
我们一定要遵循HTTP请求方法的语义,也就是说POST请求就是在新增数据等.....

资源的表述

资源的表述其实就是资源的展现形式,我们客户端和服务端传输的都是资源的表述,而不是资源本身。
例如文本资源可以采用html、xml、json等格式,图片可以使用png、jpg展现出来。
那么客户端如何知道服务端提供那种表述形式呢?
可以通过HTTP内容协商,客户端可以通过Accept头请求一种特定格式的表述,服务端则通过Content-Type告诉客户端资源的表述形式。

这些资源的表述呈现在页面上,就是我们说的资源状态。

状态转移

我们在看页面的时候,从当前资源的表述(也可以说状态或者表现层)会跳转到其他的资源状态。
服务端通过超媒体告诉客户端当前状态有哪些后续状态可已进入。
这些类似 “下一页” 之类的连接气的就是这种推进状态的作用——指引你如何从当前状态进入下一个可能的状态。

可以得知REST风格的特点如下:

  • 在web中,只要有被引用的必要都叫资源。
  • 每个URI代表一个资源,独一无二的。
  • 客户端通过HTTP的方法,对服务器端资源进行操作。
  • 客户端和服务器之间,传递这种资源的某种表现层
  • 通过超链接的的指引,实现“表现层状态的转移”。

入股一个架构符合REST的约束条件和原则,我们就称它为RESTful架构。
一种软件的架构风格,设计风格,微客户端和服务端的交互提供一组设计原则和约束条件。

restful规范

一 面向资源编程
每个URL代表一种资源,URL中尽量不要用动词,要用名词。

二 根据method不同,进行不同的操作
GET/POST/PUT/DELETE/PATCH

** 三 在URL中体现版本**
https://www.bootcss.com/v1/mycss
https://v1.bootcss.com/mycss

四 在URL中体现是否是API
https://www.bootcss.com/api/mycss

** 五 在URL中的过滤条件
https://www.bootcss.com/v1/mycss?page=3

六 尽量使用HTTPS

七 响应设置状态码
1** 信息,服务器收到请求,需要请求者继续操作
2** 成功,操作被成功接收并处理
3** 重定向,需要进一步的操作以完成请求
4** 客户端错误,请求包含语法错误或无法完成请求
5** 服务器错误,服务器在处理请求的过程中发生了错误

八 返回值
GET请求 返回查到所有或单挑数据
POST请求 返回新增的数据
PUT请求 返回更新数据
PATCH请求 局部更新 返回更新整条数据
DELETE请求 返回值为空

九 返回错误信息
返回值携带错误信息

十 Hypermedia API
如果遇到需要跳转的情况 携带调转接口的URL

ret = {
    code: 100,
    data: {
        id: 1,
        name: '小明',
        depart_id: 'http://www.baidu.com/api/v1/depart/4/'
}
}

你可能感兴趣的:(RESTful 规范)