Restful Api 分析与实践

1、何为api?

在说Restful Api 之前我们先来说说api?这个大家应该都知道,就是我们通常所说的接口,基于面向接口开发模式的使用,api也运用的非常广泛。
我们来分析一个需求,如果我想获取一个用户发的说说列表。

QQ空间网站里面需要这个功能。
Andoid APP里面也需要这个功能。
iOS APP里面也需要这个功能。

那么现在就有三套,那么按照传统的开发网站的结构,你就要写3套获取用户说说列表的功能。也就是需要在3个地方都写连接mysql,查询mysql。这样用的缺点是,
1.写了大量冗余的代码,代码重复量大。
2.安全性低,过分的暴露数据,容易被破解。

那么API就是为了解决这种情况而诞生,由一个地方统一提供API接口,哪个平台想使用就直接调用这个API接口来获取信息就可以了。

web: https://api.qzone.com/user/getUserFeedList?from=web
Android: https://api.qzone.com/user/getUserFeedList?from=android
iOS: https://api.qzone.com/user/getUserFeedList?from=ios
我们写了一个接口,就可以供3个地方同时使用了,我们加一个from参数来区别平台,因为可能每个平台想要的数据不一样。

这样不仅保证了数据安全,减少了代码冗余,提高了工作效率,最主要是分工更快速了。一个人专门写接口,另外一个人只需要知道如何调用就可以了,完全不需要知道是如何实现的。

2、什么是Rest?

REST这个词,是Roy Thomas Fielding在他2000年的博士论文中提出的。

Fielding将他对互联网软件的架构原则,定名为REST,即Representational State Transfer的缩写。我对这个词组的翻译是”表现层状态转化”。

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

要理解RESTful架构,最好的方法就是去理解Representational State Transfer这个词组到底是什么意思,它的每一个词代表了什么涵义。

REST的名称”表现层状态转化“中,省略了主语。”表现层”其实指的是”资源”(Resources)的”表现层”

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

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

表现层(Representation)

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

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

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

状态转化(State Transfer)

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

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

客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:

GET用来获取资源,

POST用来新建资源(也可以用于更新资源),

PUT用来更新资源,

DELETE用来删除资源。

可以总结为一句话:

REST是所有Web应用都应该遵守的架构设计指导原则
面向资源是REST最明显的特征,对于同一个资源的一组不同的操作。资源是服务器上一个可命名的抽象概念,资源是以名词为核心来组织的,首先关注的是名词。REST要求,必须通过统一的接口来对资源执行各种操作。对于每个资源只能执行一组有限的操作。

综合上面的解释,我们总结一下什么是RESTful架构:

  (1)每一个URI代表一种资源;
  
  (2)客户端和服务器之间,传递这种资源的某种表现层;
  
  (3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现”表现层状态转化”。
  

3、什么是RESTful API?

简述:

符合REST架构设计的API。

4、RESTful架构设计误区分析

最常见的一种设计错误,就是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

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

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

    http://www.example.com/app/1.0/foo

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

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

参考:
理解本身的REST架构风格
http://www.infoq.com/cn/articles/understanding-restful-style/

理解RESTful架构
http://www.ruanyifeng.com/blog/2011/09/restful.html

Restful API设计指南
http://www.ruanyifeng.com/blog/2014/05/restful_api.html

阮一峰 理解RESTful架构
http://www.ruanyifeng.com/blog/2011/09/restful.html

猜你喜欢

转载自blog.csdn.net/dengchenrong/article/details/79035070