リンク・コンポーネントの定義

リンク・コンポーネントは、ある操作によって返されたさまざまな値を、他の操作の入力として使用する方法を記述するために使用できる、再使用可能なリンク定義です。 このようにして、リンクは、操作間の既知の関係とトラバーサル・メカニズムを提供します。

このタスクについて

注:
  • このタスクは 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 定義内の他の場所から参照する必要があります。

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

手順

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