RESTful学习及应用

原文转自前端路上,转载请注明出处:http://refined-x.com/2017/09/22/RESTful学习及应用/

RESTful是什么

RESTful是一种API架构,符合REST设计原则的API都可以被称为RESTful,REST的全称是Representational State Transfer

REST的核心原则是后端将资源发布为URI,前端通过URI访问资源,并通过HTTP动词表示要对资源进行的操作,典型的RESTful API长这样:

POST /article           //增加一篇文章
DELETE /article/1       //删除id为1的文章
PUT /article/1          //修改id为1的文章
GET /article/1         //查询id为1的文章

这里需要明确一个概念:资源,后端提供的所有内容都可以被定义为资源,前端用户的一切行为,本质都是与一系列后端资源互动的结果。从这个角度来讲,前端的意义就是连接用户与资源,使用户能以最简单的方式调度后端资源,并将调度结果以用户最容易接受的方式呈现出来。

为什么使用RESTful

前后端分离的本质是前后端以API为界限进行开发解耦,所以前后端分离的副产品是大量的API,采用RESTful架构可以让API的表现力更强,更易于被理解;对于接口开发来说,RESTful风格也更易于扩展,这对于大型项目非常重要。

RESTful是无状态的,因此无论前端是什么设备,前端是什么状态,都可以无差别的请求资源,有利于后端实现分布式。

RESTful允许前端索取指定格式的信息,因此可以实现一套统一的API服务于不同的前端设备。

如何构建RESTful API

一、每个网址代表一种资源,网址中只能有名词

网址仅用来表示资源的名称,而不包括操作,因此只能由名词组成;但有些资源可能自带操作属性,比如转账,这时候我们应该将转账看成一种服务(名词),将转账的其他信息作为参数传递

二、对于资源的操作类型由HTTP动词表示

常用的四种HTTP动词以及对应的SQL操作。

GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)
DELETE(DELETE):从服务器删除资源。

三、统一的返回结果

针对不同操作,服务器向用户返回的结果应该符合以下规范。

GET /collection:返回资源对象的列表(数组)
GET /collection/resource:返回单个资源对象
POST /collection:返回新生成的资源对象
PUT /collection/resource:返回完整的资源对象
PATCH /collection/resource:返回完整的资源对象
DELETE /collection/resource:返回一个空文档

四、返回正确的状态码

常用状态码

200 :服务器成功返回用户请求的数据
400 :用户发出的请求有错误
401 :表示用户没有权限
403 : 表示用户得到授权(与401错误相对),但访问被禁止的
404 :用户发出的请求针对的是不存在的记录
500 :服务器发生错误,用户无法判断发出的请求是否成功

五、允许通过HTTP内容协商

客户端可以通过Accept头请求一种特定格式的表述,服务端则通过Content-Type告诉客户端资源的表述形式。若服务器不支持,它应该返回一个HTTP 406响应,表示拒绝处理该请求。

通常项目中最常用的还是直接预定为JSON格式。

web端的应用

目前最流行的web端AJAX类库当属axios,axios与RESTful完美兼容,主要体现在以下几个方面。

axios将HTTP动词直接封装为方法,正好对应RESTful的API风格,在RESTful架构中使用起来非常方便

axios.post(`/artical`, params)
axios.delete(`/artical/1`, params)
axios.put(`/artical/1`, params)
axios.get(`/artical/1`, params)

而且axios的返回数据包括响应正文和状态码等信息,配合拦截器很容易实现对RESTful API错误码的统一处理。

//错误处理
axios.interceptors.response.use(function(response) {
  return response;
}, function(error) {
  if (error.response) {
    switch (error.response.status) {
      case 400:
        
        break;
      case 401:
        
        break;
      case 403:
        
        break;
      ...
    }
  }
});

更多axios内容参考这里

最后

其实RESTful的绝大多数内容都是规范推荐的做法,没有什么新东西,只不过前几年后端MVC盛行的时期,没有这么重的API开发需求,在这方面就一切从简了,近来赶上前后端分离的东风,API设计又被大家重视起来了,重回规范的RESTful相当于让大家见识了一下当年规范制定者们的远见卓识,就像小时候不听话的孩子在长大的某一天里突然想起来长辈曾经的教诲一样。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,194评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,058评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,780评论 0 346
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,388评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,430评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,764评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,907评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,679评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,122评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,459评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,605评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,270评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,867评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,734评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,961评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,297评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,472评论 2 348

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,745评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,629评论 18 139
  • 百花诗 88 夹竹桃 青竹翠叶不虚心,团簇桃花假乱真。 芬苾红黄毒暗底,不一表里惊世人。
    PikeTalk阅读 174评论 0 0
  • 《把你的英语用起来》 像打游戏一样学习,嗯,对,学习就是打游戏。 大家先打开看大图,文末再说话。嘿嘿! 这个假...
    x深蓝阅读 1,608评论 5 17
  • 1970-90年代是人类学的美国时代,在稳定的全球政治经济格局下讨论社区,及社区中人的社会性与生物性的结合。美国人...
    顽童小逗豆阅读 714评论 0 1