ヘッダーの作成

ヘッダーは、API 要求で送信したり、API 応答で返したりすることができる情報を定義します。 API 定義内のさまざまな場所でヘッダーを作成することができます。

開始前に

ヘッダーの作成ウィンドウを起動します。 ヘッダーを作成できる API 定義内の領域の詳細については、以下のトピックを参照してください。

このタスクについて

注:
  • このタスクは OpenAPI 3.0 API 定義の構成に関連しています。 OpenAPI 2.0 API 定義の構成方法について詳しくは、 OpenAPI 2.0 API 定義の編集を参照してください。
  • OpenAPI 3.0 API は、 DataPower® API Gatewayでのみサポートされ、 DataPower Gateway (v5 compatible)ではサポートされません。
  • 現在の OpenAPI 3.0 サポートの制限について詳しくは、 IBM® API Connect での OpenAPI 3.0 のサポートを参照してください。

このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。

ヘッダーはパラメーターに似ていますが、以下の点が異なります。
  • パラメーターには実際のデータが含まれており、エンド・ユーザーに対して使用可能ですが、ヘッダーには要求または応答に関連付けられたメタデータが含まれており、エンド・ユーザーに対して表示されません。
  • パラメーターはさまざまな位置に配置できますが、ヘッダーの位置は常に header に設定されます。
  • パラメーターにはさまざまな形式スタイルを設定できますが、ヘッダーのスタイルは常に simple です。
パラメーターについて詳しくは、 パラメーターの作成を参照してください。

いつでも、 「ソース」 アイコン OpenAPI ソース・アイコンをクリックして、基礎となる OpenAPI YAML ソースに直接切り替えることができます。 設計フォームに戻るには、 「フォーム」 アイコン フォーム・アイコンをクリックします。

手順

  1. ヘッダーを作成します。最初からヘッダーを作成することも、ヘッダー・コンポーネントで定義されているヘッダーを参照することもできます。
    • 最初からヘッダーを作成するには、「定義」タブで以下の情報を指定します。
      • ヘッダー名: ヘッダー・コンポーネントを作成する場合、この名前は、API 定義内の他の場所からこのヘッダーを参照できるようにするためのキーを定義します。参照の形式は次のとおりです。
        #/components/headers/Name
      • 「説明」: ヘッダーの説明。 リッチ・テキスト表現には、 CommonMark 構文 を使用できます。
      • 必須: このヘッダーが必須かどうかを決定します。
      • 非推奨: このヘッダーが非推奨であり、使用されないようにする必要があることを指定します。
      • 空値を許可: ヘッダーを空値で送信できます。
      • 展開: これを選択すると、タイプが array または object のヘッダー値は、配列の各値またはマップのキーと値のペアに対して別個のヘッダーを生成します。
      • Allow Reserved: RFC3986 (:/?#[]@!$&'()*+,;=) で定義されているように、パーセント・エンコードなしでヘッダー値に予約文字を含めることを許可するかどうかを決定します。
    • ヘッダー・コンポーネントで定義されているヘッダーを参照するには、「参照」タブで以下の情報を指定します。
      • ヘッダー名: ヘッダー・コンポーネントを作成する場合、この名前は、API 定義内の他の場所からこのヘッダーを参照できるようにするためのキーを定義します。参照の形式は次のとおりです。
        #/components/headers/Name
      • 参照元 (Reference from): ヘッダー・コンポーネントへの参照を選択します。
  2. 「作成」をクリックします。
    さらに編集するために、ヘッダーの詳細が表示されます。 ヘッダーの編集を参照してください。