RESTful API设计中常见的问题和解决方案

在开发HTTP API的时候,我们一般会按照REST风格来设计,符合REST风格的API也称为RESTful API。

RESTful API的主要规则包括以下几点:

  • URI表示资源(名词)
  • HTTP请求的方法表示动作,指对资源的操作

标准的RESTful API示例如下:

POST /customers:创建一个消费者
GET /customers:获取消费者列表
GET /customers/{id}:获取某个具体的消费者
PUT /customers/{id}:更新某个具体的消费者信息(全量更新)
PATCH /customers/{id}:更新某个具体的消费者的信息(部分更新)
DELETE /customers/{id}:删除某个具体的消费者

// 有联系的资源之间的处理
GET /customers/{id}/orders:获取某个具体消费者的订单列表
...

RESTful API 设计指南

由于英语语法的特点和HTTP请求的方法数量的有限,可能存在一些无法覆盖到的部分,如下:

  • 非常规动作
  • 资源对应的名词形式造成的问题:单复数一致,不可数
  • 资源之间的关系是一对一

下面来谈谈上述未覆盖部分及其解决方案。

非常规动作的RESTful API的设计

常规动作有GET,POST,PUT,PATCH和DELETE,也就是所谓的增删改查,但是现实中还有很多非前面提到的动作,如取消操作。

针对非常规动作,解决的方案有两种:

  • 动词名词化:将动词转成名词,进而当做前面资源的子资源进行处理
  • 自定义方案:使用自定义的规范来支持非常规动作

下面我们以取消订单为例,来看看针对该问题不同方案的实现。

动词名词化

该方案是GitHub在使用中的方案,在开放的API的可以看到。

Star a gist

针对实例的实现如下:

POST /orders/{id}/cancellation

自定义方案

这个Google Could中Could API设计规范中定义的方案,语法为:

https://service.name/v1/some/resource/name:customVerb

Custom Methods

针对实例的实现如下:

POST /orders/{id}:cancel

资源对应的名词形式造成的问题的解决

资源对应的名词单复数一致

该情况可按照英语语法使用对应的名词即可,如下:

// 单复数一致
GET /advice  
GET /advice/{id}

资源对应的名词为不可数名词

使用可数名词来代替,如news可以用news-items来代替。

资源之间的关系是一对一情况的处理

这种情况可以采用资源对应的名词的单数形式来表示获取一条数据, 该方案也适用于多对一的情况。

例如:用户的购物车数据,每个用户有一个购物车,可以表示如下:

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