アセンブリーへのエレメントの追加

API Designer「アセンブル」 ビューを使用して、API アセンブリーを作成します。 APIエディタの 「Gateway 」タブをクリックすると、「Assemble」ビューにアクセスできます。

このタスクについて

注:
  • このタスクは 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 ConnectAI Gateway での OpenAPI 3.0 のサポートを参照してください。

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

UI のアセンブリー・ツールを使用して、任意の API 操作に対して行われる要求や、任意の API 操作によって行われる応答の操作に使用されるアセンブリーを作成します。

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

「ソース」 ビューを使用して API 定義のソースを編集する場合は、 OpenAPI YAML の構成方法について詳しくは、 execute OpenAPI 拡張 を参照してください。

アセンブリツールの使用方法の詳細については、 「アセンブリエディタ」 を参照してください。

手順

アセンブリー・ツールを使用してエレメントをアセンブリーに追加するには、以下のステップを実行します。
  1. ナビゲーション ペインで [開発] ナビゲーション・ペインの「開発」アイコン をクリックし、 [API ] タブを選択します
    「開発」 ページが開きます。
  2. 作業する API 定義のタイトルをクリックします。
  3. 「ポリシー」 ビューを使用して、エレメントを追加します。
    注: ポリシーのバージョンを指定する必要があります。 APIとゲートウェイ間でポリシーのバージョンが一致しないことによるエラーを防ぐため、API内のポリシーバージョンがゲートウェイ上の API ConnectAI Gateway バージョンと完全に一致する場合にのみ、APIをゲートウェイに公開します。
    1. 「ゲートウェイ」 タブを選択し、ナビゲーション・ペインで 「ポリシー」 をクリックします。
    2. キャンバスの適切な場所にプラスアイコン 円の中にプラス記号 をクリックすると、利用可能な要素が一覧表示されたパレットが表示されます。
    3. パレットからキャンバスに追加したい要素をクリックして選択してください。
      注:
      • エレメントは、最初の塗りつぶされていない円から、最後の塗りつぶされた円に順に適用されます。
      • 「操作切り替え」 エレメントが使用されない限り、API のすべての操作にアセンブリー全体が適用されます。
    4. エレメントをクリックし、プロパティー・シートを使用して、エレメントのプロパティーを追加または編集します。
      一部のエレメントでは、「オブジェクト・プロパティー (Object Properties)」をクリックし、ドロップダウン・リストからプロパティーを選択することで、プロパティーを追加および削除することができます。 ポリシー要素の特性については、「 APIポリシーとロジック構造」 を参照してください。 論理構文の特性については、 「論理構文」 を参照してください。
    5. ポリシーのバージョンを指定します。
      バージョンを追加するには、 [ソース ] アイコン OpenAPI ソース・アイコンをクリックし、ポリシー YAML の version セクションを完了させてください。 例:
      execute:
        - invoke:
            version: 2.2.0
            title: invoke
      ...
      使用しているゲートウェイと互換性のあるバージョンをポリシーに指定する必要があります。 API の公開時に、バージョンがゲートウェイと非互換の場合、使用可能なバージョンを指定する検証エラーがスローされます。 ポリシー OpenAPI YAML の構成方法について詳しくは、 execute OpenAPI extensionを参照してください。
  4. 必要に応じて: 追加したい要素がある場合は、手順 3.b から 3.e を繰り返してください。
  5. 変更内容を保存するには、 「保存」 をクリックします。

結果

アセンブリーに 1 つ以上のエレメントを追加しました。