API 入门(5)OpenAPI 的 Paths 对象

在上一篇文章中,我们了解了 OpenAPI 文档对象的最小组成结构,但是没有定义任何 API,可以说没有使用价值。接下来,我们就动手在文档中描述一个 API.

在 OpenAPI 规范中,把 API 端点(API Endpoints)称为 Paths. API 支持的所有操作,都包含在 Paths 对象中。

在 Paths 对象中,每一个字段都是 Path Item 对象类型,Paht Item 对 API 端点进行描述。Paths 对象可以包含多个 Path Item 对象,每一个Path Item 对象都是一个独立的字段,而不是把所有的 Path Item 都放到一个数组中。这样做的好处是,可以通过 JSON 或 YAML 的语法规则,保证端点的唯一性。

每个 Pahts 的第一个字符必须使用 / ,因为 Paths 需要附加到服务器 URL 后面的。

在 Path Item 对象中,使用 Operation 对象对 HTTP 的方法名,如 GET、PUT 或者 DELETE,进行描述。

paths:
  /hello:
    get:
      ...
    put:
      ...

Operation 对象可以使用 summarydescriptionparametersresponse 字段进行详细描述。

paths:
  /hello:
    get:
      summary: 打招呼
      description: 向大家问好!
      parameters:
        ...
      responses:
        ...

调用 API 可能返回的的响应对象,用 Responses 对象来表示。而对于每个具体的响应,使用 HTTP 的响应状态码作为字段名称来表示。需要注意的是,状态码数字要放到引号里。

paths:
  /hello:
    get:
      responses:
        "200":
          ...
        "404":
          ...
         "5xx":
          ...

每个 Response 对象必须强制包含 description 字段,对响应对象进行描述。而最重要的 content 字段包含了响应的内容。

paths:
  /hello:
    get:
      responses:
        "200":
          description: 打招呼,成功了。
          content:
            ...

经过上面对讲解,下面对代码片段就容易理解了:

openapi: 3.1.0
info:
  title: OpenAPI 文档示例
  description: |
    本文档中的 API 描述仅用于学习。
  version: 1.0.0
paths:
  # 这里是注释
  /hello:
    get:
      summary: 你好,读者
      description: 这里是对端点的描述,打个招呼
      responses:
        "200":
          description: "OK"
          content:
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容