API 入门 (28) 使用 OpenAPI 描述 REST API——查询参数数据

我们在使用 OpenAPI 规范描述资源和操作时,只是对操作的响应进行了简单的描述。从本文开始,我们将要对操作的输入和输出的数据进行详细的描述。

首先,我们要对输入数据,也就是操作的参数进行描述。为了查询一辆自行车,我们要发送这样一个请求:GET /bikes?key={value}. 为了描述这个参数,我们需要为 /bikes 资源的 get 操作增加一个 parameters 属性,并添加查询参数 key

openapi: '3.0.2'
info:
  title: 自行车在线商城 REST API 文档。
  version: '1.0'
servers:
  - url: https://api.server.test/v1
paths:
  /bikes:
    description: 自行车目录
    get: 
      summary: 查询自行车目录
      description: |
        在自行车目录中,使用关键词,
        查询匹配条件的自行车。
      parameters: #1
        - name: key #2
          description: | #3
            自行车的名称,编号或描述的部分信息
          in: query #4
          required: false #5
          schema: #6
            type: string
      responses:
        "200":
          description: |
            满足查询条件的自行车

parameters 属性是一个数组,数组中每个元素都表示一个参数,并以短横线(-)开头。一个参数必须包含nameinschema三个属性,requireddescription 是可选属性。

下面对 6 个注释对地方进行重点解释:

  • #1,参数的名称
  • #2,参数的描述
  • #3,参数的位置,query 表示查询参数
  • #4,表示参数是否必须提供,默认值 false
  • #5,参数的数据结构
  • #6,参数的类型

schema 属性中的数据结构,其实是一个 JSON 的 schema. Open API 文档就是使用 JSON 的 schema 描述数据结构。schema 不只是包含一个 type 属性,还可以描述更复杂的数据结构。在描述请求体参数和响应数据时,我们就会用到。

小结

在本节中,我们为查询自行车的操作添加了查询参数,并使用 schema 属性定义了查询参数的数据结构。

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

推荐阅读更多精彩内容