ターゲット・サービスからの REST プロキシー API の作成

IBM® API Connect API 定義を介して公開する既存の REST サービスがある場合は、プロキシー API を作成し、 API Designerを使用してターゲット・エンドポイントを指定することができます。

このタスクについて

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

このタスクを実行するには、Api-Drafts:Edit、Settings:View、および App:View の許可を持つロールが割り当てられている必要があります。 事前に提供されている開発者のロールには、デフォルトでこれらの許可があります。カスタム・ロールが割り当てられている場合は、これらの許可が必要です。 詳しくは、 カスタム・ロールの作成を参照してください。

API Designer ツールを使用して、プロキシー REST API を数分で作成し、 ターゲット・サービスから APIを作成します。 この手順では、すべてのトラフィックをターゲット REST API またはサービス・エンドポイントにルーティングする REST プロキシーを作成します。

手順

ターゲット・サービスからプロキシー API を作成するには、以下のステップを実行します。

  1. ナビゲーション・ペインで、 API UI ナビゲーション・ペインの「開発」アイコン 「開発」をクリックしてから、 「追加」 > 「API」をクリックします。
    「API タイプの選択」画面が表示されます。
  2. API のベースとなる OpenAPI 仕様のバージョンに応じて、 OpenAPI 2.0 または OpenAPI 3.0 を選択します。
  3. 「ターゲット・サービスから」を選択します。
  4. 「次へ」をクリックします。 「情報」セクションで API の要約を指定します。 API は、作成後に微調整できます。
    • 「タイトル」には、特殊文字を含めることができます。ただし、ユーザー・インターフェースに簡単に表示できるように短いものにしてください。
    • 「名前」 は自動的に入力されます。 「名前」 フィールドの値は、 デベロッパーズ・ツールキット CLI コマンドで API を識別するために使用される単一のストリングです。 ドラフト API を管理するための CLI コマンドを表示するには、 ツールキット CLI リファレンス資料を参照してください。
    • Version は、API の OpenAPI 定義の info.version プロパティーの値に対応します。 version.release.modification というバージョン番号付け方式 (例えば 1.0.0) が推奨されます。
    • 「基本パス」は API の URL セグメントであり、ホスト名や、パスおよび操作の追加セグメントは含まれません。 基本パスに特殊文字を含めることはできません。また、特殊文字が空の場合でも、 / 文字で開始する必要があります。
    • オプションの「説明」は、API の識別に役立ちます。
  5. ターゲット サービス URL フィールドに、呼び出す既存の REST API エンドポイントを指定します。
  6. 「次へ」をクリックします。 「保護」セクションで、必要な API セキュリティーを構成します。
    • クライアント ID を使用した保護 - このオプションは、アプリケーションがクライアント ID (API キー) を提供する必要がある場合に選択します。 これにより、 X-IBM-Client-Id パラメーターが API の要求ヘッダーに組み込まれます。 このオプションを選択すると、API 呼び出しをキーごと (クライアント ID ごと) に制限するかどうかを選択できます。
      • キー単位で API 呼び出しレートを制限する - このオプションを選択した場合、必要なレート制限を構成する必要があります。 レート制限は、ある期間 (時、分、月、または日) 内に許可されている呼び出し最大数を制御します。 例えば、1 時間当たり 100 回の呼び出しです。
    • CORS - このオプションは、API の CORS (cross-origin resource sharing) サポートを有効にする場合に選択します。 これにより、別のドメインから API にアクセスできるようになります。
      注:
      • CORS サポートは、 DataPower® API Gatewayでのみ使用可能です。
      • CORS を有効にした場合、API ゲートウェイは cors プリフロー・ポリシーを実行して、API に対して発行されたすべての CORS 要求を処理します。
      • CORS が有効にされていて、プリフライト要求が受け取られた場合、以下の API アクションのみが実行されます。
        • cors プリフロー・ポリシーは、適切な応答ヘッダーを構成します。
        • 応答ヘッダーが設定されます。
      • プリフライト要求が受け取られると、request.attributes.isCORSPreflight フラグが true に設定されます。
      • すべてのプリフライト要求において、security プリフロー・ポリシーと client-identification プリフロー・ポリシーは、CORS が有効にされているかどうかに関係なく、常にスキップされます。
  7. API 定義を作成するには、 「次へ」 をクリックします。

    「要約」パネルに、定義が作成されたことを示すメッセージが表示され、選択されたセキュリティー・オプションおよびレート制限が適用されます。

  8. 以下のオプションのいずれかを選択してください。
    • API をさらに構成するには、「API の編集」をクリックします。 詳しくは、 API 定義の編集を参照してください。
    • この時点では API をこれ以上構成しない場合は、パンくずリスト内の「開発」リンクをクリックしてウェルカム・ページに戻ります。その後、すぐに別のタスクに進むことができます。 後で API を構成する方法について詳しくは、 API 定義の編集を参照してください。

結果

既存のターゲット・サービスからプロキシー API を作成しました。

次のタスク

API を製品に組み込んでから、その製品をカタログに公開することによって、アプリケーション開発者がその API を使用できるようになります。 詳細については、「 製品およびカタログの操作 」を参照してください。