パスのサーバーの定義

オンラインで編集する

パスのサーバー定義により、そのパスで 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 ConnectAI Gateway での OpenAPI 3.0 のサポートを参照してください。

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

注: パスに対してサーバーを定義する必要はほとんどありません。これは、API 操作が異なるゲートウェイ・エンドポイントに分散されている場合にのみ適用されるためです。そのような構成は、 API ConnectAI Gatewayの外部の独自のランタイム・エンドポイントで API 操作をホストしている場合にのみ可能です。 DataPower API Gatewayに公開されている API の場合、すべての API 操作が同じゲートウェイ・サービスで呼び出されます。

パスに対して定義されたサーバーは、親 API に対して定義されたサーバーをオーバーライドします。 複数のサーバーを定義できますが、最初のサーバーのみが API ConnectAI Gatewayによって使用されます。

Draft comment: garychapman
Please advise on any additional contextual information we need to add around defining servers for a Path

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

手順

  1. OpenAPI 3.0 API 定義の編集で説明されているように、編集のために API を開きます。
  2. 「パス」を展開します。
  3. 必要なパスを展開し、そのパスに既に 1 つ以上のサーバーが定義されている場合は、 「サーバー」を展開します。
  4. 「パス」の新しいサーバー定義を作成するには、ナビゲーションペインの「パス」の下にある 「サーバー」 の横にある OpenAPI 3.0 API 追加アイコン 追加アイコンをクリックします。 既存のサーバー定義を編集するには、ナビゲーション・ペインの「パス」の下で対象のサーバー URL をクリックします。
  5. 以下の情報を指定します。
    • サーバー URL (必須): ここで指定された URL は、API が公開されているカタログ内のバニティー・エンドポイント構成に応じて、API を呼び出すための完全な URL エンドポイントを決定するために使用されます。 DataPower API Gatewayによって強制される API の場合、ここに入力された値は基本パスとして解釈されるため、通常は基本パス値のみを指定します。以下に例を示します。
      /my_basepath
      URLが URLを決定するためにどのように使用されるかについての詳細は 、「カタログのバニティエンドポイントの設定」 を参照してください。
    • サーバーの説明 (オプション): URL によって指定されるホストの説明。 リッチテキストの表現には、 CommonMark 構文を使用できます。
    • サーバー変数 (既存のサーバー定義を編集する場合に使用可能): サーバー変数は、変数名とその値の間のマップを定義します。 この値は、サーバーの URL テンプレートでの置換に使用されます。
      1. 新しいサーバー変数を追加するには、 「追加」をクリックします。 既存のサーバー変数を編集するには、対象の変数名をクリックします。
      2. 以下の情報を指定します。
        • サーバー変数名 (必須)。
        • デフォルト 値 (必須)。
        • (オプション) リッチ・テキストの説明。 リッチテキストの表現には、 CommonMark 構文を使用できます。
        • 1 つ以上の「列挙値」エントリー (既存のサーバー変数を編集する場合に使用可能)。 列挙値は、置換オプションが制限されたセットからのものである場合に使用される列挙型のストリング値を指定します。 新しい列挙値を追加するには、「追加」をクリックして値を入力し、「作成」をクリックします。 既存の列挙値を編集するには、対象の列挙値をクリックします。
      3. 新しいサーバー変数を作成する場合は、「作成」をクリックします。 サーバー変数の詳細が表示され、さらに編集することができます。
      4. 必要に応じて、パンくずリストを使用してサーバー定義に戻り、さらに編集することができます。
  6. 新規サーバー定義を作成する場合は、 「作成」をクリックします。
    5で説明されているように、さらに編集するためにパスの詳細が表示されます。
  7. 完了したら、 「保存」 をクリックします。