API 入门 (32) 使用 OpenAPI 描述 REST API——路径参数

当我们在检索、更新或删除自行车资源时,需要通过路径指定要操作的资源,如下所示:

GET /bikes/{bikeId}
PUT /bikes/{bikeId}
DELETE /bikes/{bikeId}

可以看到,路径中包含了一个路径参数{bikeId},使得 /bikes/{bikeId} 成为一个可变路径。换句话说,bikeId(自行车标识)取不同的值,路径指向的资源就不同。但是,只要bikeId的值一定,在执行检索、更新或删除操作时,返回的自行车信息就是同一个资源的。

下面,我们使用 OpenAPI 规范,对检索和删除操作进行描述,看看能否发现一些问题。

检索自行车

下面是检索自行车的示例代码。

  /bikes/{bikeId}:
    description: 自行车信息。
    get:
      summary: 检索自行车。
      parameters:
        - name: bikeId
          in: path
          required: true
          description: 自行车标识
          schema:
            type: string
      responses:
        "200":
          description: 对应标识的自行车信息

删除自行车

下面是删除自行车的示例代码。

  /bikes/{bikeId}:
    description: 自行车信息。
    delete:
      summary: 删除自行车。
      description: 删除一个指定的自行车。
      parameters:
        - name: bikeId
          in: path
          required: true
          description: 自行车标识
          schema:
            type: string
      responses:
        "200":
          description: 已删除的自行车信息

发现问题

通过比较上面两个操作的描述信息,我们可以很容易发现,路径参数的描述信息是相同的。

  parameters:
    - name: bikeId
      in: path
      required: true
      description: 自行车标识
      schema:
        type: string

不要重复发明轮子,那该如何处理呢?使用组件。

参数组件

在组件集合属性中,不仅可以定义可重用的 schema,也可以定义可重用的参数。

components:
  parameters:
    bikeId:
      name: bikeId
      in: path
      required: true
      description: 自行车标识
      schema:
        type: string

引用参数

接下来,在检索自行车删除自行车时,我们就可以引用 bikeId 路径参数了。

paths:
  /bikes:
  [...]
  /bikes/{bikeId}:
    get:
      parameters:
        - $ref: #/components/parameters/bikeId
      [...]
    delete:
      parameters:
        - $ref: #/components/parameters/bikeId
      [...]

还有问题

你一定又发现重复的数据描述了。下面的描述信息出现了两次。

- $ref: #/components/parameters/bikeId

如果考虑到更新自行车时,也会使用相同的描述,这一行信息会出现 3 次。能否消除这种重复的情况呢?

资源参数

路径参数 bikeId 被定义了一次,在检索和删除两个操作中进行了引用。需要明确的是,路径参数 bikeId 不是操作层级的参数,而是资源层级的参数。因此,我们可以在资源属性下面进行定义,这样,就可以省去在每个操作中进行定义。

components:
    parameters:
      bikeId:
        [...]
paths:
  /bikes/{bikeId}:
    parameters:
      - $ref: #/components/parameters/bikeId
    get:
      [...]
    delete:
      [...]
    put:
      [...]

这样看起来,是不是更加完美了。

小结

我们使用组件对象,定义了路径参数,避免在多个资源操作中进行描述;然后,我们路径参数的引用,放到了资源层级的参数中,不必在每个操作中重复引用。经过两次重构,文档变得更加简洁,清晰。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容