Rest接口设计之个人理解

前言

关于Rest是什么,本文不做任何介绍。这里记录的是:在多年的工作经验中,从书上学到的、代码中看到的接口规范的个人理解与总结。有不正确的地方,欢迎大家指正。
在当前的项目开发中,不同模块之间通常采用API来访问数据,如何约束和管理开发人员交付的接口风格保持一致,开发人员之间彼此能够快速理解、减少不必要的沟通呢?我相信大部分团队在项目开发之初都会针对团队现状制定一些基础接口规范,这样在一定程度上可以明确职责、加快项目进度。当然我也遇到过一些反例,相互之间扯皮的时间都够完成大部分需求开发了。言归正传,既然说到了接口规范了,我就以当前流行的Rest约束作为模板,谈谈我的理解。

REST规范

关于REST API接口,我的总结是:
REST API接口 = 资源地址(URI) + 请求方法(HTTP VERB)
大家可能会说,你是不是少了请求参数?没有,之所以不提参数,因为它不直接影响接口的设计与规范。
一个标准、规范、友好的API接口,应该做到资源地址与请求方法隔离,互不影响。如何理解这名话,请继续往下看。

资源地址(URI)

  1. 为什么是URI,而不是URL?
    在REST原则中,最重要的是定义资源,资源定义好了,其对应的标识符也就有了,那接口的目的就是通过资源的标识符去访问这些资源。因此,这里需要的是资源标识符(URI),而不是资源定位符(URL)。
  2. 资源地址由名词构成
    明确了上述概念,就不难理解为什么资源地址由名词构成了。比较好的示例大家可以参考豆瓣APIGitHub API,可以说是我见过的最标准的API。说白了,接口地址就是资源标识符,因此,它理应由名词组成,不应夹杂着动词出现。大家在实际项目中肯定见过这样的反例:http://xxx.com/abc/def/getUserList或者http://xxx.com/abc/def/createXXX。其实,这就是典型的资源地址与请求方法耦合的例子,开发者可能会说,这样写可以很明确的告诉使用者接口的目的或效果。但实际上呢?这属于多此一举,而且严重违反了REST的设计理念。因为,HTTP协议中已经定义好了资源的增、删、改、查方法。
  3. 资源由复数表示
    定义资源时,通常是对某个对象或服务的抽象,而接口实际上是对抽象后的对象或服务的集合的操作,因此,强烈建议在定义资源地址时使用复数,如http://xxx.com/api/v1/users,表示对用户资源的基本操作。

请求方法

REST原则(或约束)其实是对HTTP协议的补充,本质上也是HTTP请求。HTTP协议已经定义好了常用的增、删、改、查方法,分别对应HTTP请求的POST、DELETE、PUT和GET方法。设计出上一小节那样反例的同学要么是不清楚HTTP协议、要么就是不理解REST原则。因此,遵守最基本的HTTP协议方法就可以让你在无形中成为了REST约束的实践达人。看,就是这么简单。

最佳示例

方法 示例 说明
GET /users 返回用户列表,后面可添加分页信息,如?limit=10&offset=0
GET /users/c12dl3 返回ID为c12dl3的用户详情
POST /users 创建新用户
PUT /users/c12dl3 修改ID为c12dl3的用户信息
DELETE /users/c12dl3 删除ID为c12dl3的用户

写在最后

最核心的两点已经介绍完了,其实关于REST原则还有很多内容,但都没有以上内容可以让人更直观的理解,而且有些特性在实践中很难被真正落实,所以不提也罢。

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

推荐阅读更多精彩内容

  • 一说到REST,我想大家的第一反应就是“啊,就是那种前后台通信方式。”但是在要求详细讲述它所提出的各个约束,以及如...
    时待吾阅读 3,400评论 0 19
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,566评论 18 139
  • REST接口设计规范 URI格式规范 URI(Uniform Resource Identifiers) 统一资源...
    零一间阅读 8,145评论 1 5
  • 人有灵,后有魂。 传说, 人死后就是灵魂。 灵魂会进入冥府轮回,天干地支,一甲子一轮回。 然而,执念越深,越难以被...
    菊漠涟阅读 440评论 0 1
  • 上午十点半的时候,拉开窗帘,北京下雪了,2017年第一场,这个冬天的第三场雪,雪花很大朵,却很快停了。手机里存的是...
    阿瞒abc阅读 619评论 2 2