API 入门(7)OpenAPI 参数和载荷

上一篇文章中,我们了解了 API 的响应内容的格式,也可以说是 API 操作的输出数据。有输出数据,就有输入数据。本文就说一说 API 操作的输入数据。

OpenAPI 提供了两种方式描述输入数据:参数(parameters)和请求体/消息载荷(request body/message payload)。两种参数的作用略有差别。参数常用于识别一类资源;而请求体是对资源内容的描述。

参数对象(Parameter Object)

在 OpenAPI 文档中,Path Item 对象和 Operation 对像都可以保护一个 parameters 字段,该对象是参数对象的一个数组。parameters 字段出现的位置不同,影响也不同。在 Path Item 对象中的 parameters 字段,其内容会被 Path 对象下的所有操作共享;而在 Operation 对象中的 parameters 字段,其内容会覆写 Path Item 对象中 parameters 字段的内容,但不能移除。

每个参数对象都包含下面两个强制字段:

  • in(字符串):参数位置
  • name(字符串):在同一个参数位置,名称必须唯一,且大小写敏感。

还有几个重要的可选字段:

  • description(字符串):参数描述,可以包含使用示例。对于理解文档非常有帮助。
  • required(布尔值):是否必需,默认值是 false.

参数位置

最常见的参数位置,有以下三个:

  • path:参数成为操作路径(URL)的一部分,俗称路径参数。
 /users/{id}:
    get:
      parameters:
      - name: id
        in: path
        required: true

需要注意的是,路径参数的 required 字段必需为 true.

  • query:参数成为操作路径(URL)查询参数的一部分,俗称查询参数,如/users?id=123456
 /users:
    get:
      parameters:
      - name: id
        in: query
  • header:参数成为 HTTP 请求头的一部分,俗称请求头参数。注意:请求头是大小写敏感的。

参数类型

参数类型可以使用 schema 字段进行描述:

parameters:
- name: id
  in: query
  schema:
    type: integer
    minimum: 1
    maximum: 100

请求体对象(Request Body Object)

请求体包含在操作对象中,可以使用 requestBody 字段进行描述,表示为一个请求体对象。在请求体对象中,content 字段是强制字段,描述了请求体的细节。

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

推荐阅读更多精彩内容