doubleyong
管理员
管理员
  • 最后登录2026-05-25
  • 发帖数1198
  • 最爱沙发
  • 喜欢达人
  • 原创写手
  • 社区居民
  • 忠实会员
阅读:7818回复:0

[框架]restful api 一种接口设计思想

楼主#
更多 发布于:2018-07-29 17:01
网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。


因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。


一、 理解RESTful架构(http://www.ruanyifeng.com/blog/2014/05/restful_api.html )

定名为REST,即Representational State Transfer的缩写。我对这个词组的翻译是"表现层状态转化"。


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


要理解RESTful架构,最好的方法就是去理解Representational State Transfer这个词组到底是什么意思,它的每一个词代表了什么涵义。如果你把这个名称搞懂了,也就不难体会REST是一种什么样的设计。


资源(Resources)
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用来删除资源。


综述


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


(1)每一个URI代表一种资源;


(2)客户端和服务器之间,传递这种资源的某种表现层;


(3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。


二、restful API 的架构

1、 域名
应该尽量将API部署在专用域名之下。
https://api.example.com

如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。
https://example.org/api/

2、版本(Versioning)
应该将API的版本号放入URL。
https://api.example.com/v1/

另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。


3、路径(Endpoint)
路径又称"终点"(endpoint),表示API的具体网址。


在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。


举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
等等,还有很多设计,请参考:RESTful API 设计指南http://www.ruanyifeng.com/blog/2014/05/restful_api.html


三、restful 架构与其它架构的区别


除restful , 常见的架构还有soap WebService, 关于web Service的介绍,请看下图:


图片:r1.png





二者之间的区别


图片:r2.png





图片:r3.png







参考:
http://www.ruanyifeng.com/blog/2011/09/restful.html 理解restful架构
http://www.ruanyifeng.com/blog/2014/05/restful_api.html RESTful API 设计指南

https://www.imooc.com/video/14352 restful 课程
知识需要管理,知识需要分享
游客


返回顶部

公众号

公众号