[程序员每日5分钟] 初识 RESTful

什么是RESTful

RESTful API

RESTful是一种设计风格,并不是一种标准。

简短的去概括的话,就是:
1、URL 定位资源

资源,就是数据。比如newsfeed,friends,order等

2、用 HTTP 动词描述操作。

GET、PUT、POST、DELETE

我为什么要用TA

1、以前的开发方式都是前后端混在一起开发,比如php里面写html啊之类的。那么移动开发再加上web,我们岂不是要维护三个地方。
2、随着版本迭代,项目越来越大,如果api杂乱无章,那么维护起来更是无法控制。
3、所以,我们就要有所约束,而RESTful就是利用HTTP本身的一些特征来制定的风格。


如何设计RESTful?

  • REST ful 是面向资源的,而资源是通过 URI 进行暴露。

(一)、URI 的设计只要负责把<b>资源</b>通过合理方式暴露出来就可以了
(二)、对资源的<b>操作</b>与它无关,操作是通过 <b>HTTP 动词</b>来体现。
(三)、所以 REST ful 通过 URI 暴露资源时,会强调<b>不要</b>在 URI 中出现动词。
(四)、推荐用<b>复数</b>。

不太理解吗?来看个栗子:

比如:左边是错误的设计,而右边是正确的

GET /rest/api/getDogs | GET /rest/api/dogs 获取所有狗 
POST /rest/api/addDogs | POST /rest/api/dogs 添加一个狗    
PUT /rest/api/editDogs/:dog_id | PUT /rest/api/dogs/:dog_id 修改一只狗 
DELETE /rest/api/deleteDogs/:dog_id | DELETE /rest/api/dogs/:dog_id 删除一只狗 
左边的这种设计,很明显不符合REST风格。

上面已经说了,URI 只负责准确无误的暴露资源,而 getDogs/addDogs... 已经包含了对资源的操作,这是不对的。
相反右边却满足了,它的操作是使用标准的HTTP动词来体现。

  • REST ful 很好地利用了HTTP本身就有的一些特征,如HTTP动词、HTTP状态码、HTTP报头等等

(一)、REST ful 是基于 HTTP 的,所以你的API应该去使用 HTTP的一些标准。这样所有的HTTP客户端(如浏览器)才能够直接理解你的API。
(二)、REST ful 强调利用好 HTTP 本来就有的特征。

不太理解吗?一个一个解释:
一、HTTP 动词
GET      获取一个资源 
POST     添加一个资源 
PUT      修改一个资源 
DELETE   删除一个资源

实际上,这四个动词实际上就对应着增删改查四个操作,这就利用了HTTP 动词来表示对资源的操作

二、HTTP状态码

在与 API 的交互当中,无非就三种状态:

200   OK                       成功
400   Bad Request              客户端错误
500   Internal Server Error    服务器端错误
三、HTTP报头
Authorization   认证报头 
Cache-Control   缓存报头 
Content-Type    消息体类型报头 
...

报头还有很多,不一一列举。
HTTP报头是描述HTTP请求或响应的 <a href="http://baike.baidu.com/link?url=ljPKp9OCm01gS4b3_YP1qnEg5zTbPgQkNl-TaQQrQNkAspc-pd8FLMQ5_GAHDZ5q0vFtVH-pLntA8aqfeLzHb3MsqIpHlpjbxPcJ9ebgWzqpt8vYTN4eX8lOAIQju_Tn">元数据。</a>
它的作用是客户端 与 服务器端进行相互通信时,告诉对方应该如何处理本次请求。


一些实例如醍醐灌顶

GET http://localhost:8080/api/students 可以获得所有的学生信息。

GET http://localhost:8080/api/students/1 可以获得id为“1”的学生信息。

POST 以下JSON内容 
{"id":0,"firstName":"Edison","lastName":"Di","gender":"M",
"birthday":538300800000,"uscId":"1234509876","gpa":3.62,
"mentorId":null,"department":"Computer Science"}
到 http://localhost:8080/api/student 可以添加一个学生信息。

PUT 以下内容 
{"gpa":3.62}  
到 http://localhost:8080/api/students/1 可以修改学生ID为1的学生的GPA.

DELETE http://localhost:8080/api/students/1 可以删除学生ID为1的信息。

最后

本文章主要是让大家认识一下什么是REST ful,大家如果需要继续深入理解和学习的话,请进<a href="https://github.com/aisuhua/restful-api-design-references">传送门</a>
恭喜你,工资又涨了100块。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,552评论 18 139
  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 3,396评论 0 19
  • 转自:http://www.runoob.com/w3cnote/restful-architecture.htm...
    艾尔温阅读 999评论 0 51
  • 解释一 REST -- REpresentational State Transfer 直接翻译:表现层状态转移。...
    时间之友阅读 2,220评论 0 10
  • 从今天开始,我开始学习Retrofit,整体Retrofit内容如下: 1、Retrofit解析1之前哨站——理解...
    隔壁老李头阅读 6,083评论 4 46