メインコンテンツまでスキップ

Headerオブジェクト

ヘッダー オブジェクトは、パラメーター オブジェクトの構造に従いますが、次の変更があります。

  1. nameを指定してはなりません。対応するheadersマップで指定されます。
  2. inを指定してはなりません。暗黙的に headerに含まれます。
  3. 場所によって影響を受けるすべての特性は、header(たとえば、style) の場所に適用できなければなりません。

ヘッダーオブジェクトの例​

integerタイプのシンプルなヘッダー:

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