API Gateway を API Hub に接続する

このページでは、API Gateway を Apigee API Hub に接続して、API を表示し、API 管理を一元化する方法について説明します。

概要

API Gateway 管理者が API Gateway を API Hub に接続するには、次の手順を行います。

API Hub をプロビジョニングする
API Gateway プロジェクトを API Hub に関連付ける

始める前に: ロールを付与する

API Gateway を API Hub に接続するための適切な Identity and Access Management（IAM）ロールがあることを確認します。

API Hub をプロビジョニングするプロジェクトで、次の操作を行います。

API Hub のプロビジョニング手順の始める前にで説明されているように、プロビジョニングのロールを付与します。

API Hub にアタッチする API Gateway プロジェクトで、次の操作を行います。

プリンシパルアカウントに Cloud API Hub ランタイムプロジェクトアタッチメント編集者（roles/apihub.runTimeProjectAttachmentsEditor）ロールを付与します。
Google Cloud コンソールを使用して API Gateway プロジェクトを API Hub に関連付けるには、プリンシパルアカウントに閲覧者（roles/browser）ロールを付与します。

API ハブをプロビジョニングする

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

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

ホストプロジェクトで API Hub をプロビジョニングするには、次のいずれかを行います。

Google Cloud コンソールで、[API Hub] ページに移動し、ホストプロジェクトとして使用する Google Cloud プロジェクトを選択して、[API Hub を設定] をクリックします。

このページには、次のように API Gateway ページからアクセスできます。
- API Gateway ページのいずれかのページの上部にある API Hub バナーで [使ってみる] をクリックします。
- [APIs] ページの上部にある [API Hub を使ってみる] をクリックします。
次に、Cloud コンソールで API Hub をプロビジョニングするで説明されている詳細なプロビジョニング手順に沿って操作します。
コマンドラインまたは Terraform を使用します。

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

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

Google Cloud コンソール

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

Google Cloud コンソールで、[API Hub] ページに移動します。
[API ハブ] に移動
左側のナビゲーションメニューで [設定] をクリックして、[設定] ページを開きます。
[プロジェクトの関連付け] タブに移動します。
API Gateway プロジェクトがアタッチされたランタイムプロジェクトのリストにない場合は、次の操作を行います。
1. [ランタイムプロジェクトを接続] をクリックします。
  [リソースを選択] ペインが表示されます。
2. API Gateway がプロビジョニングされている Google Cloud プロジェクトをクリックします。
3. [プロジェクトの関連付けの設定] ペインで、[API Gateway] と、自動インポートする他の API アセットを選択します。
4. [保存] をクリックします。
API Gateway プロジェクトがアタッチされたランタイムプロジェクトのリストにすでに含まれている場合は、次の操作を行います。
1. API Gateway ランタイムプロジェクトに関連付けられている行で、[設定を編集] をクリックします。
2. [プロジェクトの関連付けの設定] ペインで、[API Gateway] と、自動インポートする他の API アセットを選択します。
3. [保存] をクリックします。

REST

API Gateway プロジェクトを API Hub に関連付けるには、ランタイムプロジェクトの関連付けを作成する API とプラグインインスタンスを作成する API を使用します。

たとえば、ランタイムプロジェクトの添付ファイルを作成するには:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT_ID/locations/HUB_LOCATION/runtimeProjectAttachments?runtimeProjectAttachmentId=RUNTIME_PROJECT_ID" \
  -X POST \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{"runtimeProject":"projects/RUNTIME_PROJECT_ID"}'

次のように置き換えます。

HUB_PROJECT_ID: API Hub のホストプロジェクトの名前。API Hub のプロビジョニング時にホストプロジェクトが選択されました。
HUB_LOCATION: ホストプロジェクトのロケーション。API Hub のプロビジョニング時にロケーションが選択されました。
RUNTIME_PROJECT_ID: API Gateway ランタイムプロジェクトの名前。

成功すると、RuntimeProjectAttachment JSON オブジェクトが返されます。

次に、API Gateway プラグインインスタンスを作成します。

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT_ID/locations/HUB_LOCATION/plugins/PLUGIN_TYPE/instances" \
  -X POST \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "API Gateway Plugin Instance",
    "sourceProjectId": "RUNTIME_PROJECT_ID",
    "actions": [
      {
        "actionId": "sync-metadata"
      }
    ]
  }'

次のように置き換えます。

HUB_PROJECT_ID: API Hub のホストプロジェクトの名前。API Hub のプロビジョニング時にホストプロジェクトが選択されました。
HUB_LOCATION: ホストプロジェクトのロケーション。API Hub のプロビジョニング時にロケーションが選択されました。
PLUGIN_TYPE: プラグインのタイプ。system-api-gateway に設定します。
RUNTIME_PROJECT_ID: API Gateway ランタイムプロジェクトの名前。

成功すると、オペレーション JSON オブジェクトが返されます。