API Gateway と API Hub を使ってみる

このチュートリアルでは、API Gateway を API Hub に接続して、API Gateway プロジェクトから API Hub への API メタデータのシームレスな公開を有効にする方法について説明します。

このチュートリアルでは、 Google Cloud コンソールを使用します。

タスクリスト

次のタスクリストを参照しながら、チュートリアルを実施してください。API Gateway を API Hub に接続するには、すべてのタスクを行う必要があります。

1. 始める前にに記載されている前提条件の手順を実行します。

2. API を API Gateway にデプロイする。

3. API Gateway プロジェクトを API Hub に関連付けます。

4. API Hub で API Gateway API を表示する。

5. Google Cloud アカウントへの課金が発生しないようにします。クリーンアップをご覧ください。

始める前に

始める前に、次の前提条件の手順を完了していることを確認してください。

1. プロジェクトで API Gateway を設定します。

2. ホスト プロジェクトで API Hub を設定します。

プロジェクトで API Gateway を設定する

プロジェクトで API Gateway を設定する手順は次のとおりです。

1. Google Cloud コンソールで、[API Gateway] ページに移動します。

   API Gateway に移動

   注: このチュートリアルで作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの終了後にそのプロジェクトを削除すれば、プロジェクトに関連するすべてのリソースを削除できます。

2. API Gateway では、次の Google サービスを有効にする必要があります。

   名前	タイトル
   apigateway.googleapis.com	API Gateway API
   servicemanagement.googleapis.com	Service Management API
   servicecontrol.googleapis.com	Service Control API

   選択したプロジェクトでこれらのサービスをまだ有効にしていない場合は、有効にするよう求められます。

3. お支払いが有効になっていることを確認します。

   課金を有効にする方法について

ホスト プロジェクトで API Hub を設定する

1. ホスト プロジェクトとして使用する Google Cloud プロジェクトを作成または選択します。

   ホスト プロジェクトは、 Google Cloud 組織内の Google Cloud プロジェクトであり、すべての API Hub リソースのコンシューマー プロジェクトとして指定します。ホスト プロジェクトごとに 1 つの API Hub インスタンスをプロビジョニングできます。

   すべての API Gateway で API を一元的に検出できるようにするには、API Hub インスタンスに 1 つの専用ホスト プロジェクトを使用し、複数の API Gateway プロジェクト（ランタイム プロジェクト）を API Hub インスタンスにアタッチすることをおすすめします。

   Google Cloud 組織またはフォルダに API Hub のインスタンスがすでにプロビジョニングされている場合は、この手順をスキップして、既存の API Hub インスタンスに API Gateway プロジェクトを関連付けることをおすすめします。

2. API Gateway を API Hub に接続するために必要な Identity and Access Management（IAM）ロールを付与します。

3. ホスト プロジェクトで API Hub をプロビジョニングします。

API Gateway に API をデプロイする

API Gateway のクイックスタートを完了して、「hello world」Cloud Run サービスをデプロイし、そのサービスを指すゲートウェイを作成します。

たとえば、helloworld API は helloworld-gateway API Gateway にデプロイされます。これは、 Google Cloud コンソールの [ゲートウェイ] ページに表示されます。

API Gateway プロジェクトを API Hub にアタッチする

API Gateway プロジェクトを API Hub にアタッチする手順は次のとおりです。

1. Google Cloud コンソールで、[API Hub] ページに移動します。

   [API ハブ] に移動

2. プルダウンで API Hub ホスト プロジェクトを選択します。
3. 左側のナビゲーション メニューで [設定] をクリックして、[設定] ページを開きます。
4. [プロジェクトの関連付け] タブに移動します。
5. [ランタイム プロジェクトを接続] をクリックします。
   [リソースを選択] ペインが表示されます。
6. API Gateway がプロビジョニングされている Google Cloud プロジェクトをクリックします。
7. [プロジェクトの関連付けの設定] ペインで、[API Gateway] と、自動インポートする他の API アセットを選択します。
8. [保存] をクリックします。

ランタイム プロジェクトがアタッチされ、 Google Cloud コンソールの [アタッチされたランタイム プロジェクト] のリストに表示されます。

次に例を示します。

リアルタイム データ取り込みを有効にするため、API Gateway アセットをインポートするように選択すると、API Hub はアタッチされたランタイム プロジェクトの API Gateway プラグイン インスタンスを作成します。このプラグイン インスタンスは、[プロジェクトの関連付け] ページの [関連付けられたプラグイン] 列で確認できます。

API Hub で API Gateway API を表示する

API Hub で API Gateway API を表示する手順は次のとおりです。

1. Google Cloud コンソールで、API Hub の [API] ページに移動します。

   [API ハブ] に移動

2. API Gateway にデプロイした「hello world」API を見つけます。

   必要に応じて、[フィルタ] プルダウンで [Gateway: API Gateway] を選択して、API Gateway API のみを表示します。

   次に例を示します。

   

3. API をクリックすると、API メタデータなどの詳細が表示されます。

クリーンアップ

このチュートリアルで使用したリソースについて Google Cloud アカウントに課金されないようにするには:

• ゲートウェイを削除する
• API を削除する

このチュートリアルで使用した Google Cloud プロジェクトの削除もできます。

次のステップ

• API Gateway についての詳細を確認する
• API ハブを使用して API を一元化する方法の詳細を確認する