什么是RESTful API?

提到RESTful API 大家势必或多或少听说过。但是什么是RESTful API ?如何理解RESTful API 呢?请大家耐心读完这篇文章,相信您读完后一定会有一个更好的理解。我个人认为,要弄清楚什么是RESTful API,首先要弄清楚什么是REST。REST 全称:REpresentational State Transfer,英文翻译过来就是“表现层状态转化”。如果单看这个概念,估计大家很难理解。那下面就让我来用一句话通俗解释一下。 RESTful:用URL定位资源用HTTP动词(GET、POST、PUT、DELETE)描述操作**。只要记住这句话也就不难理解了。

Resource:资源,即数据。 Representational:某种表现形式,比如用JSON,XML,JPEG等; State Transfer:状态变化。通过HTTP动词实现。

名词解释

URI(统一资源标识符):可以唯一标识一个资源
URL(统一资源定位符):可以提供找到某个资源的路径,比如平时最常见的网址:

一般一个URL也是一个URI,比如上面的网址,即URL可以看做是URI的子集,在图书领域中一本书都有唯一的一个isbn编号,这个编号其实也是URI。

RESTful API就是REST风格的API,即rest是一种架构风格,跟编程语言无关,跟平台无关,采用HTTP做传输协议。 那么在什么场景下使用RESTful API呢?在当今的互联网应用的前端展示媒介很丰富。有手机、有平板电脑还有PC以及其他的展示媒介,从而你的系统的客户端要支持浏览器、Android、ios等。此时你肯定不会单独为每个客户端写一个后台系统,而是写一个后台系统提供rest风格的URI,这三个客户端都请求该同一个后台系统。那么这些前端接收到的用户请求统一由一个后台来处理并返回给不同的前端肯定是最科学和最经济的方式如(图1-1)。RESTful API就是一套协议来规范多种形式的前端和同一个后台的交互方式。

 图1-1 前后端分离

前后端分离之后,我们就不用在前端页面中写jstl,el表达式了,甚至连jsp都不需要使用了,直接html即可,前端跟后端的交互使用ajax+json这样符合rest风格的架构即可,这样做的好处就是

RESTful API就是REST风格的API,即rest是一种架构风格,跟编程语言无关,跟平台无关,采用HTTP做传输协议。 那么在什么场景下使用RESTful API呢?在当今的互联网应用的前端展示媒介很丰富。有手机、有平板电脑还有PC以及其他的展示媒介,从而你的系统的客户端要支持浏览器、Android、ios等。此时你肯定不会单独为每个客户端写一个后台系统,而是写一个后台系统提供rest风格的URI,这三个客户端都请求该同一个后台系统。那么这些前端接收到的用户请求统一由一个后台来处理并返回给不同的前端肯定是最科学和最经济的方式如(图1-1)。RESTful API就是一套协议来规范多种形式的前端和同一个后台的交互方式。

 图1-1 前后端分离

前后端分离之后,我们就不用在前端页面中写jstl,el表达式了,甚至连jsp都不需要使用了,直接html即可,前端跟后端的交互使用ajax+json这样符合rest风格的架构即可,这样做的好处就是
RESTful API就是REST风格的API,即rest是一种架构风格,跟编程语言无关,跟平台无关,采用HTTP做传输协议。 那么在什么场景下使用RESTful API呢?在当今的互联网应用的前端展示媒介很丰富。有手机、有平板电脑还有PC以及其他的展示媒介,从而你的系统的客户端要支持浏览器、Android、ios等。此时你肯定不会单独为每个客户端写一个后台系统,而是写一个后台系统提供rest风格的URI,这三个客户端都请求该同一个后台系统。那么这些前端接收到的用户请求统一由一个后台来处理并返回给不同的前端肯定是最科学和最经济的方式如(图1-1)。RESTful API就是一套协议来规范多种形式的前端和同一个后台的交互方式。

 图1-1 前后端分离

前后端分离之后,我们就不用在前端页面中写jstl,el表达式了,甚至连jsp都不需要使用了,直接html即可,前端跟后端的交互使用ajax+json这样符合rest风格的架构即可,这样做的好处就是

  • 项目的分工更加明确了
  • 实现了前后端的解耦
  • 可以将前端和后端部署到不同的服务器上来减轻服务器的压力
  • 前后端代码在不同的服务器上,可以提高安全性

基于以上的这些因素,rest架构的风格越来越流行了。说完好处,我们继续来介绍RESTful API。

RESTful API由后台也就是SERVER来提供前端来调用。前端调用API向后台发起HTTP请求,后台响应请求将处理结果反馈给前端。也就是说RESTful 是典型的基于HTTP的协议。那么RESTful API有哪些设计原则和规范呢?

1、资源。首先是弄清楚资源的概念。资源就是网络上的一个实体,一段文本,一张图片或者一首歌曲。资源总是要通过一种载体来反应它的内容。文本可以用TXT,也可以用HTML或者XML、图片可以用JPG格式或者PNG格式,JSON是现在最常用的资源表现形式。

2、统一接口。RESTful风格的数据元操CRUD(create,read,update,delete)分别对应HTTP方法:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源,这样就统一了数据操作的接口。

3、URI。可以用一个URI(统一资源定位符)指向资源,即每个URI都对应一个特定的资源。要获取这个资源访问它的URI就可以,因此URI就成了每一个资源的地址或识别符。一般的,每个资源至少有一个URI与之对应,最典型的URI就是URL。

4、无状态。所谓无状态即所有的资源都可以URI定位,而且这个定位与其他资源无关,也不会因为其他资源的变化而变化。有状态和无状态的区别,举个例子说明一下,例如要查询员工工资的步骤为第一步:登录系统。第二步:进入查询工资的页面。第三步:搜索该员工。第四步:点击姓名查看工资。这样的操作流程就是有状态的,查询工资的每一个步骤都依赖于前一个步骤,只要前置操作不成功,后续操作就无法执行。如果输入一个URL就可以得到指定员工的工资,则这种情况就是无状态的,因为获取工资不依赖于其他资源或状态,且这种情况下,员工工资是一个资源,由一个URL与之对应可以通过HTTP中的GET方法得到资源,这就是典型的RESTful风格。

说了这么多,到底RESTful长什么样子的呢?下面我们举一些例子。

GET:http://www.xxx.com/source/id 获取指定ID的某一类资源。

GET:http://www.xxx.com/friends/123表示获取ID为123的用户的好友列表。如果不加id就表示获取所有用户的好友列表。

POST:http://www.xxx.com/friends/123表示为指定ID为123的用户新增好友。其他的操作类似就不举例了。

还是回顾我们最开始说到的那句话,即用URL定位资源用HTTP动词(GET,POST,PUT,DELETE)描述操作。

在rest中会通过向服务器提交的请求类型来表示增删改查这些操作
GET(SELECT):从服务器取出资源。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源。
DELETE(DELETE):从服务器删除资源。

RESTful API还有其他一些规范。

RESTful API还有其他一些规范。
RESTful API还有其他一些规范。

①、应该将API的版本号放入URL。GET:http://www.xxx.com/v1/friend/123。或者将版本号放在HTTP头信息中。我个人觉得要不要版本号取决于自己开发团队的习惯和业务的需要,不是强制的。

②、URL中只能有名词而不能有动词,操作的表达是使用HTTP的动词GET,POST,PUT,DELETEL。URL只标识资源的地址,既然是资源那就是名词了。

③、如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。?limit=10:指定返回记录的数量、?page=2&per_page=100:指定第几页,以及每页的记录数。

如果觉得我的文章对你有用,请随意赞赏