Restful API 和RPC API

总结一下

  • RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。(感觉比较适合大型项目、多团队合作项目)
  • RPC的核心思想是把本地的方法映射到API,比如我本地有一个方法是getUser()

RESTful的可读性更好,即使完全不了解业务,看到API也知道这个接口是干嘛的,但是有时候不好抽象,比如login操作,你用Restful如何抽象?
Restful规范最大的好处:命名统一,避免相同的功能因为命名风格不同,而创建了一大堆冗余的接口。既浪费了编程资源(相同的功能写了多个接口),又不好维护(修改一个功能,要修改多个命名不同的接口)

RPC规范的话,当然是简单暴力,后端程序员更喜欢,写给自己小伙伴的接口规范,但是在大型项目、多team合作项目、前后端分离项目时,可读性很差。有时候一个功能相同接口,会出现好几个。因为可能项目移交给别的team做,新team没空研究之前的代码,直接写一个新的接口完成同一个业务功能。
比如

  • /getUser?id=,
  • /getUserById?id=
  • /getUserByPrimary?id=
    但是有了restful规范的话,就可以大大降低这种事情的概率,因为都是 GET /users/{id}

REST VS RPC

  1. REST的主体是资源,而RPC更侧重于动作。

  2. REST更偏向外部调用,RPC更偏向内部调用。在国内,一般更偏向于RPC,比如阿里出的dubbo;在国外,更倡导REST,比如spring cloud,是个纯REST的项目,不支持RPC。(当然,近几年REST在国内也开始火起来了)

  3. REST其实是个效率很低的东西,特别是需要联合查询的时候;并且有些东西,也不好抽象成资源,比如用户登录、用户退出

  4. RPC只需要关心业务场景,但是如果业务理解不够,你可能不会理解这些API是做什么用的(优秀的RESTful API的设计,就算不懂业务,只要会一些英文,应该通过URL就能猜到每个API是做什么的)。

  5. 前端可能更喜欢REST,而后端估计更倾向于RPC。

restful api细节

还是看阮一峰大佬的博客吧,更详细,摘录几个印象比较深的点

  1. 必须要摒弃RPC的做法啊,比如新增用户
    标准写法: POST /users
    如果你写成 POST /users/add,那么就会有人写成: POST /users/insert ,POST /users/create,所以宾语必须是名词,而且最好是统一用复数

  2. 避免多级 URL
    GET /authors/12?categories=2

  3. response 必须是json的

  4. 返回正确的code

参考

阮一峰大佬的博客
http://www.ruanyifeng.com/blog/2018/10/restful-api-best-practices.html

讲区别的
http://www.360doc.com/content/18/0730/00/99071_774291878.shtml

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

推荐阅读更多精彩内容