ステップ 7: Apigee 環境にデプロイする

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示します。

Apigee in VS Code でローカルの開発とテストが完了したら、API をアーカイブとして Apigee 環境にデプロイする準備が整いました。このステップでは、アーカイブ デプロイをサポートする Apigee 環境を作成し、API プロキシ構成のアーカイブを Apigee 環境にデプロイします。

  1. 環境を作成するの手順に沿って、以下のことを行います。
    1. Apigee 組織に新しい 開発環境を作成し、デプロイタイプとしてアーカイブを有効にします。UI または API を使用します。

      次に例を示します。

      アーカイブ デプロイタイプの設定を示している新しい環境ダイアログ

    2. Instance attachment API を使用して、ランタイム インスタンスに環境を接続します。

      このコマンドは、長時間実行オペレーションをトリガーします。続行する前に、環境がランタイムに接続されているかを確認してください。

    3. 環境グループをまだ作成していない場合は、環境グループ API の作成を使用して作成します。

      続行する前に、環境グループが作成されていることを確認してください。新しいグループのステータスは、次のようなリクエストを使用して確認できます。

      curl -i -H "$AUTH" -H "Content-Type:application/json" \
  "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"
    4. Environment group attachment API を使用して、新しい環境を環境グループに接続します。

      グループに環境を接続すると、グループ内のホスト名を介して、その環境内のプロキシがルーティング可能になります。これによって長時間実行オペレーションがトリガーされます。完了するまで数分かかることがあります。次のステップに進む前に、1～2 分待つことをおすすめします。その間に、上記のようにオペレーションのステータスを確認できます。

  2. Apigee 環境に API プロキシ構成のアーカイブをデプロイします。
    1. Apigee in VS Code の [Terminal] タブで、myapigeeworkspace ディレクトリに移動します。
      cd myapigeeworkspace

      ls を実行すると、ディレクトリに src フォルダが含まれます。

    2. 以下のコマンドを実行します。 
      gcloud beta apigee archives deploy --environment=dev --labels=release=052021

      レスポンスの例を次に示します。

      Using Apigee organization dev
Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done
  3. [Terminal] タブで次のコマンドを実行して、API をテストします。
    curl https://INTERNAL_LOAD_BALANCER_IP/helloworld /
  -H "Host: ENV_GROUP_HOSTNAME"

    この例の変数と API アクセスの設定方法について詳しくは、サンプル プロキシをデプロイするをご覧ください。

    次のエラー メッセージが表示されます。 

    {"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey",
  "detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

    API キーを取得するには、helloworld API を含む API プロダクトを作成し、API プロダクトとともにデベロッパーを作成して登録する必要があります。

  4. API キーを取得します。
    1. Apigee UI を使用して API プロダクトを作成します。
      1. [Publish] > [API Products] を選択します。
      2. [+ Create] をクリックします。
      3. [Product details] に、API プロダクトの詳細を入力します。
      4. 各フィールドに次の情報を入力します。
        フィールド 設定
        Name: myproduct
        Display name: myproduct
        Environment: dev
        Access: Public
        Quota: 空白のまま
        Allowed OAuth scope: 空白のまま
      5. [Operations] セクションで、[+Add an Operation] をクリックします。
      6. [Source] で、API プロキシ プルダウン メニューから [helloworld] を選択します。
      7. [Operation] で、[Path] フィールドに「/」と入力します。

        他のフィールドはデフォルト設定のままにします。

      8. [Save] をクリックして、オペレーションを保存します。
      9. [Save] をクリックして、API プロダクトを保存します。
    2. 組織内にデベロッパーを作成します。
      1. サイド ナビゲーション メニューで、[Publish] > [Developers] を選択します。
      2. [+ デベロッパー] をクリックします。
      3. 各フィールドに次の情報を入力します。
        フィールド 設定
        First Name: Alex
        Last Name: Hamilton
        Username: ahamilton
        Email: ahamilton@example.com
      4. [作成] をクリックします。
    3. 次のようにアプリを登録します。
      1. [Publish] > [Apps] を選択します。
      2. [+ App] をクリックします。
      3. 各フィールドに次の情報を入力します。
        フィールド 設定
        Name: myapp
        Display name: myapp
        Developer: ahamilton@example.com
        Callback URL: 空白のまま
        Notes: 空白のまま
        Expiry: 無期限
        Product:
        1. [Add Product] をクリックします。
        2. [myproduct] を選択します。
        3. [Add] をクリックします。
        Custom attributes: 空白のまま
    4. API キーをコピーします。
      1. [Apps] ページ（[Publish] > [Apps]）で、[myapp] をクリックします。
      2. [myapp] ページで、[Credentials] セクションの [Key] の横にある [Show] をクリックします。作成した API プロダクトに API キーが関連付けられていることを確認してください。
      3. API キーを選択してコピーします。
  5. 以下のように apikey クエリ パラメータを使用して API キーを渡し、curl 呼び出しを再度実行します。
    curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    以下のようなレスポンスが返されます。

    {
  "root": {
    "city": "San Jose",
    "firstName": "John",
    "lastName": "Doe",
    "state": "CA"
  }
}

これで完了です。これで、API アーカイブを Apigee 環境に正常にデプロイできました。

次のステップでは、API アーカイブを Apigee の本番環境に昇格させます。

1 2 3 4 5 6 7 （次）ステップ 8: アーカイブを本番環境に昇格させる