Rest API命名感悟

Rest API,一种Web Service接口的风格,定义了规范和约束。主要偏向资源,而资源所指的就是我们页面中的
可控数据。而传统的SOAP所主要偏向的则是过程。而它们则成为了资源运输的管道,通过我们所编写的URI。而
应着两者偏向角度问题的不同,针对所它们设计的URI也会有所不同。
<URI并非绝对某种形式就是某种风格,只能说它的形式相对某种情形下定义了它是某种风格的产物>
关于URI和URL的概念,就是一个相对和绝对的资源标识。如果要深入了解,大家可以自己在到网上深入了解一下。
(如下是两者编写时所产生的URL)
---------------------SOAP----------------------
http://www.test.com/users/1/del
or
http://www.test.com/users?del=1
---------------------REST----------------------
[DELETE] http://www.test.com/users/1
因为SOAP偏向的是过程,因而我们所设计的URI,在当中我们可能需要提供或者说告知我们这个是什么功能。
而REST偏向的是资源,所以增、删、改、查,都与该资源无关。所以在上面我们没有看到对应的表示删除的del单词。
在了解这些内容以后,大致我们能够了解到的一个REST API命名的规范:只使用名词。
而我们说Rest作为一种规范和约束,它着重告诉我们的是我们在命名的时候应该要考虑的某些方面,它规范了
我们的思维,也拓宽了我们的思想。而非单单的使用名词去命名这么简单的就过去了的。
而如何去体现这个概念呢,下面是我在《伯乐在线》看到的博文的地址,我觉得挺实在的,大家可以看一下。
http://blog.jobbole.com/70511/
在此对《伯乐在线》以及本博文的作者JustinWu表示感谢。
当中我们可以看到,作者以实际的业务出发,引导我们去了解在设计API接口名称时候的思维。
而有了作者的参考,我们其实可以针对我们自身的需求去设计数据自身的规范和准则。
以下是我在了解完相关内容后设计命名的一些想法。
注意:删除操作应该杜绝通过规律性的编码去删除对应的数据,预防攻击。可以使用组合唯一的方式。
当然,删除操作是否需要也是需要斟酌的,因为用户数据是非常重要的。
[Method] [URI] [Remark]
[POST] /api/users 向user表中添加一条用户数据
[GET] /api/users 获取user表中所有的用户数据
[PUT] /api/users/1 修改user表中记录为1的用户数据
[GET] /api/users/1 获取user表中编号为1的用户数据
[GET] /api/users/1994/11/28 获取出生日期为1994/11/18的用户数据
[GET] /api/users/1/head_images 获取编号为1的用户的头像信息
[GET] /api/users/1/shops/1 获取编号为1的用户门店为1的门店信息
[DELETE] /api/users/139******34 删除user表中手机号码为139******34的用户数据
以上为个人理解的部分内容,以此与各位共勉,如果您有什么想法,请留言,我们一起进步,一起成长。
索易软件,感谢有您。

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

推荐阅读更多精彩内容

  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 3,406评论 0 19
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 1. 淡淡的男士香氛味道混着强烈的雄性荷尔蒙气息传入鼻翼时,徐嘉敏抽动着鼻子狠狠吸了一口气,仿佛要把这气息印入脑海...
    顾一宸阅读 8,732评论 213 158
  • 还清楚地记得昨天带老爹去看眼睛的一幕幕。从最开始没回来时的定计划,到前天的电话约时间,给老爹查路线,去公交站等候,...
    说书人呐阅读 335评论 0 0