API 入门(9)OpenAPI 文档字段和示例

虽然机器可读是 OpenAPI 文档的一大特点,但是,它同时也提供了传统的文档形式,让开发者容易阅读和测试。

下面就通过介绍文档字段和示例对象,来说明 OpenAPI 的传统文档能力。

文档字段

OpenAPI 的文档字段包含:描述字段(description)和摘要字段(summary)。

在 OpenAPI 文档中,除了自动产生的描述信息,几乎所有的对象都包含了一个描述字段,为对象提供额外的描述信息,方便开发者阅读和理解。

例如,假设在 API 中定义了一个参数的名字、类型和取值范围。接下来,我们可以通过描述字段,进一步补充一些描述信息,说明参数的目的,参数不同取值的效果及联系。

paths:
  /vedio/volume:
    put:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: integer
              minimum: 0
              maximum: 10
              description:
                当前视频的输出音量.
                0 表示音量最小值 (静音)。 10 表示音量的最大值。
                当设置为0时,其他音量设置无效。
              ...

此外,还有一些对象(Path Item,Operation 和 Example 对象)包含了摘要字段,可以为对象提供简短描述。

长描述

与 JSON 格式不同,YAML 的字符串通常只是一行文字,不需要加注引号。但是,如果字符串中出现了特殊字符,影响到文档的解析,就需要用单引号或双引号把字符串内容括起来。

如果描述信息很长,还要控制好内容的换行。在 YAML 文件格式中,有两类换行模式:

  • 字面模式(Literal mode):使用管道符|表示。文件输出的换行形式与源文件编写的形式一致。
  • 折叠模式(Folded mode):使用大于号>表示。文档输出格式会移除源文件中添加的所有换行符,成为一个单一的字符串。但是,在编写源文件时,可以使用空行强制换行。

字面模式换行

description: |
  这是一个多行的字
  符串。

  这是另一行字符串。

字面模式换行效果

这是一个多行的字
符串。

这是另一行字符串。

折叠模式换行

description: >
  这是一个多行的字
  符串。

  这是另一行字符串。

折叠模式换行效果

这是一个多行的字符串。
这是另一行字符串。

CommonMark 句法

description 字段还可以使用丰富的文本格式,这些文本格式需要遵循CommonMark 0.27 规范。

下面是一些常用示例:

标题

# Level 1
## Level 2
### Level 3

强调

*Emphasis*
**Strong Emphasis**
***Both***

列表

- Item 1
- Item 2
  - Item 2.1

代码

An inline `code span`.

```
A fenced code block
```

链接

[Link text](Link URL)
![Alt text](Image URL)

示例对象

如果 API 文档能够提供输入、输出参数的示例值,一定会大有裨益。你可能会想到把示例放到描述字段,还可以利用丰富的格式化手段更好地呈现。但是,OpenAPI 为我们提供了示例对象(Sample Object)用于展现示例值。使用示例对象的好处是:

  • OpenAPI 工具能够自动化处理示例对象
  • OpenAPI 文档中的示例对象能够进行独特展示
  • 模拟测试服务可以把示例对象用作返回值
schema:
  coordinate:
    type: integer
    minimum: 1
    maximum: 3
    example: 1

往期文章

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

推荐阅读更多精彩内容