ヘッダーは、API 要求で送信したり、API 応答で返したりすることができる情報を定義します。 API 定義内のさまざまな場所で以前に作成されたヘッダーを編集することができます。
ヘッダーの詳細フォームを開きます。 ヘッダーを編集できる API 定義内の領域の詳細については、以下のトピックを参照してください。
このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。
ヘッダーはパラメーターに似ていますが、以下の点が異なります。
- パラメーターには実際のデータが含まれており、エンド・ユーザーに対して使用可能ですが、ヘッダーには要求または応答に関連付けられたメタデータが含まれており、エンド・ユーザーに対して表示されません。
- パラメーターはさまざまな位置に配置できますが、ヘッダーの位置は常に
header に設定されます。
- パラメーターにはさまざまな形式スタイルを設定できますが、ヘッダーのスタイルは常に
simple です。
パラメーターについて詳しくは、
パラメーターの作成を参照してください。
いつでも、 「ソース」 アイコン 
をクリックして、基礎となる OpenAPI YAML ソースに直接切り替えることができます。 設計フォームに戻るには、 「フォーム」 アイコン 
をクリックします。
- 以下の情報を指定します。
- ヘッダー名: ヘッダー・コンポーネントを編集する場合、この名前は、API 定義内の他の場所からこのヘッダーを参照できるようにするためのキーを定義します。参照の形式は次のとおりです。
#/components/headers/Name
名前を変更するには、 「更新」をクリックし、完了したら 「保存」 をクリックします。
- 「説明」: ヘッダーの説明。 リッチ・テキスト表現には、 CommonMark 構文 を使用できます。
- 必須: このヘッダーが必須かどうかを決定します。
- 非推奨: このヘッダーが非推奨であり、使用されないようにする必要があることを指定します。
- 空値を許可: ヘッダーを空値で送信できます。
- 展開: これを選択すると、タイプが
array または object のヘッダー値は、配列の各値またはマップのキーと値のペアに対して別個のヘッダーを生成します。
- Allow Reserved: RFC3986 (
:/?#[]@!$&'()*+,;=) で定義されているように、パーセント・エンコードなしでヘッダー値に予約文字を含めることを許可するかどうかを決定します。
- スキーマ:
ヘッダーのスキーマを定義するには、 「作成」をクリックしてから、 スキーマ・コンポーネントの作成を参照してください。
ヘッダーに既にスキーマが定義されている場合は、「表示」をクリックして、そのスキーマを編集します。
スキーマの編集について詳しくは、
スキーマ・コンポーネントの編集を参照してください。
注: スキーマがスキーマ・コンポーネントを参照し、スキーマ構成がスキーマ・コンポーネントから継承されている場合、スキーマを編集することはできません。スキーマ・コンポーネントの構成について詳しくは、
スキーマ・コンポーネントの定義を参照してください。 参照先のスキーマ・コンポーネントを編集することはできますが、変更はそのスキーマ・コンポーネントが参照されているすべての場所に反映されます。
- コンテンツ: コンテンツ定義は、ヘッダーのコンテンツを記述します。
ヘッダーの新規コンテンツ定義を定義するには、 「追加」をクリックしてから、 コンテンツ定義の作成を参照してください。
既存のコンテンツ定義を編集するには、コンテンツ定義名をクリックしてから、 コンテンツ定義の編集を参照してください。
- 完了したら、 「保存」 をクリックします。
必要に応じて、パンくずリストを使用して、作業対象のオブジェクトの階層内の別の場所にナビゲートします。