RESTfull设计风格介绍

1、认识RESTfull

在前后端分离的应用模式里,后端API接口如何定义?

需要一种规范和风格来约束后端程序员对接口的定义

RESTfull就是用来约束后端程序员对接口的定义的一种风格

描述

RESTfull,即 Representational State Transfer的缩写。维基百科称其为“具象状态传输”,国内⼤部分⼈理解为“表现层状态转化”。

RESTfull是一种开发理念,维基百科说:REST是设计风格而不是标准

RESTfull架构就是:

每一个URL代表一种资源;

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

客户端用户四个HTTP动词,对服务器资源进行操作,实现“表现层状态转化”。

2、RESTfull设计方法:

域名:应该尽量将API部署在专用域名之下。

路径:路径又称“终点”,表示API的具体网址,每个网址代表一种资源

1)资源作为网址,只能有名词,不能有动词,而且所用的名词往往与数据库的表名对应

2)API的名词应该使用复数,无论子资源或者所有资源

版本:应该将API的版本号放入URL。

过滤信息:如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。

?limit=10:指定返回记录的数量

?offset=10:指定返回记录的开始位置。

?page=2&per_page=100:指定第几页,以及每页的记录数。

?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。

?animal_type_id=1:指定筛选条件

状态码:

HTTP动词:对资源的具体操作类型,常用的有四种:

GET:从服务器取出资源(一项或多项)

POST:在服务器新建一个资源

PUT:在服务器更新资源(客户端提供改变的属性)

DELETE:从服务器删除资源

错误处理:如果状态码是4xx,服务器就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。

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

GET /collection:返回资源对象的列表(数组)

GET /collection:返回单个资源对象

POST:返回新生成的资源对象

PUT:返回更新后的资源对象

DELETE:返回一个空文档

超媒体:RESTful API最好做到Hypermedia(即返回结果中提供链接,连向其他API方法),使得用户不查文档,也知道下一步应该做什么。

数据传输格式:服务器返回的数据格式,应该尽量使用JSON,避免使用XML

3、Django和DRF对比:

Django可以实现前后端分离

Django开发前后端分离的周期长

Django如果要遵守RESTfull设计风格需要自己写对应风格的路由

DRF专门实现前后端分离

DRF开发前后端分离的周期短

默认遵守的是RESTfull设计风格

REST接口开发的核心任务:

将数据库数据序列化为前端所需要的格式,并返回

将前端发送的数据反序列化为模型对象,并保存到数据库中

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

推荐阅读更多精彩内容

  • 重点内容回顾-DRF 文章共: 4391字 4图预计阅读时间: 15分钟 每日分享 Overthinking r...
    小闫同学啊阅读 817评论 0 7
  • 烦心的事很容易影响大脑运作的效率,让事情出错、关系紧绷。过多的不良情绪会影响人的做事效率。 我常常受情绪的困扰,无...
    娥姐姐阅读 396评论 1 5
  • 我叫谢小六,未满25岁,已患懒癌多年。在得病的这么多年中,我并没有及早发现懒癌,以至于癌症四处扩散,进而出现了一系...
    萱耳倾听阅读 437评论 2 2
  • 今天我又被邀请到学校踢球玩耍啦!今天妈妈都不知道有这事,后来是小饭桌的老师跟我说,让我跟段志耀奶奶一起去学校呢。我...
    荣沛鋡阅读 219评论 1 2