ヘッダー・コンポーネントの定義

オンラインで編集する

ヘッダー・コンポーネントは、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 を使用して実行できます。

ヘッダー・コンポーネントを使用するには、API 定義内の他の場所から参照する必要があります。

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

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

手順

  1. OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
  2. 「コンポーネント」 を展開し、既に 1 つ以上のヘッダー・コンポーネントが定義されている場合は、 「ヘッダー」を展開します。
  3. 新しいヘッダー・コンポーネントを作成することも、既存のヘッダー・コンポーネントを編集することもできます。
    • ヘッダーコンポーネントを作成するには、 「ヘッダー」 の横にある OpenAPI 3.0 API 追加アイコン 追加アイコンをクリックし、「 ヘッダーの作成」 を参照してください。
    • 既存のヘッダーコンポーネントを編集するには、ナビゲーションペインでヘッダーコンポーネントの名前をクリックし、「 ヘッダーの編集」 を参照してください。