API 入门 (31) 使用 OpenAPI 描述 REST API——重用组件

我们已经介绍了如何使用 OpenAPI 规范, 对添加自行车和查询自行车两个操作进行了描述。如果你细心阅读,就会发现:这两个操作都对自行车资源进行了描述。也就是说,同一个资源,被描述了两次。每个人都不想重复发明轮子,本文就来解决这个问题。

定义组件

API 入门 (8) OpenAPI 组件对象一文中,简要介绍了组件对象。我们可以把相同的数据描述,放到组件集合属性中,并在需要使用该数据的地方进行引用。

接下来,我们就在组件集合属性中,定义一个自行车资源组件。

因为自行车资源的数据结构定义是一个 schema ,所以,我们需要在 组件集合属性(components) 下的 schemas 属性中,定义一个自行车的 schema.

openapi: '3.0.2'
info:
  title: 自行车在线商城 REST API 文档。
  version: '1.0'
servers:
  - url: https://api.server.test/v1
[...]
components:
  schemas:
    bike:
      type: object
      description: 自行车
      required:
        - reference
        - name
        - price
      properties:
        reference:
          description: 自行车唯一标识
          type: string
        name:
          type: string
        price:
          type: number
        weight:
          type: number
        description:
          type: string
  • components:表示可重用的组件集合对象
  • schemas:表示可重用的 schema
  • bike:表示可重用的 schema 的名称
  • object:表示一个 JSON 对象

引用组件

我们定义了可重用的组件后,就可以在需要使用这个组件的地方进行引用了,不需要再重复定义。

在添加自行车的时候,进行引用。

  responses:
    "200":
      description: 已添加的自行车信息
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/bike"

在查询自行车的时候,进行引用。

responses:
  "200":
    description: 满足查询条件的自行车
    content:
      application/json:
        schema:
          type: array
          description: 自行车集合
          items:
            $ref: "#/components/schemas/bike"

在引用组件时,我们使用了 $ref 属性,该属性的值表示组件所在的路径。上面的两个引用,与所引用的组件位于同一个文档内,称为本地引用。当然,在一个文档中,也可以引用其他文档中的组件。

小结

在 OpenAPI 文档中,使用可重用组件,能够避免对同一数据的重复描述。这样做,不仅可以使文档更精简,也增强了文档的可维护性。

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

推荐阅读更多精彩内容