跳到主要内容

Header 对象

Header 对象除了以下改动之外与 Parameter 对象 一致:

  1. name 不能被指定,它在相应的 headers 映射中被指定。
  2. in 不能被指定,它隐含在 header 中。
  3. 所有被 location 影响的特性必须适合 header 中的一个 location,(比如 style)。

Header 对象示例

一个类型为 integer 的简单 header:

{
"description": "The number of allowed requests in the current period",
"schema": {
"type": "integer"
}
}
description: The number of allowed requests in the current period
schema:
type: integer