API 入门 (22) 转换目标为API——资源路径

往期文章:

  1. 找出资源及其关系
  2. 分析资源的操作
  3. 设计资源路径
  4. 表示为 HTTP 方法

通过分析 API 目标表格,我们发现了两个资源:目录和自行车。目录资源是集合资源,包含了自行车资源。我们该如何在 REST API 中表示他们呢?

路径规则

坦白地说,有效的 REST 路径只有一条规则:必须是唯一的。我们可以使用 /cat 或者 /catalog 表示目录的路径,只要他们是唯一的,不和其他路径相同,就是有效的 REST 路径。

你肯定发现了问题。虽然 /cat 可能是个有效路径,但是,对于第一次见到他的用户,很难猜到他代表什么资源。别忘了,REST API 的设计要以用户为中心。那么,资源路径的设计,要让用户很容易想到其表示的资源。

在前面的分析中,我们知道,目录资源是自行车资源的集合,目录资源包含自行车资源。在表示一个自行车资源时,我们有下面两个选择:

  1. /catalog/{bikeId}
  2. /bikes/{bikeId}

{bikeId} 是路径中的变量,称为路径参数。我们在访问上面的路径时,需要使用实际的自行车的标识,替换 {bikeId} ,就能访问相应的自行车资源了。

这两个资源路径哪个更好呢?这次有点儿伯仲难分了。那么,我们就制定几个规则,帮助我们设计资源路径:

  1. 资源路径必须是唯一的
  2. 资源路径使用复数表示集合资源
  3. 资源路径要能表示资源间的关系

因此,/bikes/{bikeId} 更符合我们的规则。

路径表示

经过上面的讨论,我们的资源路径也就可以写出来了:

  1. 目录资源:/bikes
  2. 自行车资源:/bikes/{bikeId}

小结

在设计资源路径时,我们仍然要坚持已用户为中心的原则。同时,遵守资源路径设计规则,始终保持对用户的友好性和一致性。

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

推荐阅读更多精彩内容