このチュートリアルでは、App Engine フレキシブル環境のインスタンスで実行されるサンプル .NET Core API および Extensible Service Proxy（ESP）を構成し、デプロイする方法について説明します。 サンプルコードの REST API は、OpenAPI 仕様を使用して作成されています。このチュートリアルでは、API キーを作成して API に対するリクエストで使用する方法も説明します。
Cloud Endpoints の概要については、Endpoints についてと Endpoints アーキテクチャをご覧ください。
目標
タスクの概要を示す次のリストを参照しながら、チュートリアルを実施してください。API にリクエストを送信するには、すべてのタスクを行う必要があります。
- Google Cloud プロジェクトをセットアップして、必要なソフトウェアをインストールし、App Engine アプリケーションを作成します。始める前にをご覧ください。
- サンプルコードをダウンロードします。サンプルコードを取得するをご覧ください。
- Endpoints の構成に使用する
openapi-appengine.yamlファイルを構成します。Endpoints を構成するをご覧ください。 - Endpoints 構成をデプロイして、Endpoints サービスを作成します。Endpoints 構成をデプロイするをご覧ください。
- サンプル API と ESP を App Engine にデプロイします。API バックエンドをデプロイするをご覧ください。
- API にリクエストを送信します。API にリクエストを送信するをご覧ください。
- API の活動を追跡します。API の活動を追跡するをご覧ください。
- Google Cloud アカウントへの課金が発生しないようにします。クリーンアップをご覧ください。
料金
このドキュメントでは、Google Cloud の次の課金対象のコンポーネントを使用します。
料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。
このドキュメントに記載されているタスクの完了後、作成したリソースを削除すると、それ以上の請求は発生しません。詳細については、クリーンアップをご覧ください。
準備
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。
-
Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。
- 後で必要になるため、プロジェクト ID をメモしておきます。
-
このチュートリアルでは .NET Core 2.x SDK が必要です。この SDK は任意のテキスト エディタで使用できます。統合開発環境（IDE）は必須ではありませんが、利便性を考慮し、以下のいずれかの IDE の使用をおすすめします。
- Visual Studio Code。macOS、Linux、Windows で動作します。Visual Studio Code を使用する場合は、必ず .NET Core 2.x もインストールしてください。
- Visual Studio 2017 for Windows。.NET Core 2.x が含まれています。Visual Studio 2017 を使用している場合は、Google Cloud Tools for Visual Studio プラグインを使用することをおすすめします。このプラグインは App Engine のデプロイを IDE 内で統合します。
- Visual Studio for Mac。.NET Core 2.x が含まれています。
サンプル API にリクエストを送信するためのアプリケーションが必要です。このチュートリアルでは、PowerShell 3.0 以降でサポートされる
Invoke-WebRequestを使った例を示します。- Google Cloud CLI をダウンロードします。
-
gcloud CLI を更新し、Endpoints コンポーネントをインストールします。
gcloud components update
-
Google Cloud CLI（
gcloud）が、Google Cloud にある対象のデータとサービスへのアクセスが許可されていることを確認します。gcloud auth login
表示された新しいブラウザタブで、アカウントを選択します。 -
デフォルト プロジェクトを実際のプロジェクト ID に設定します。
gcloud config set project YOUR_PROJECT_ID
YOUR_PROJECT_ID を実際の Google Cloud プロジェクト ID に置き換えます。他にも Google Cloud プロジェクトがあり、
gcloudを使用してそのプロジェクトを管理する場合は、gcloud CLI 構成の管理をご覧ください。 - App Engine アプリケーションを作成するリージョンを選択します。次のコマンドを実行してリージョンのリストを取得します。
gcloud app regions list
- App Engine アプリケーションを作成します。YOUR_PROJECT_ID は実際の Google Cloud プロジェクト ID に、YOUR_REGION は App Engine アプリケーションを作成するリージョンに置き換えます。
gcloud app create \ --project=YOUR_PROJECT_ID \ --region=YOUR_REGION
サンプルコードを取得する
サンプルの API をダウンロードするには:
.zip 形式のサンプルコードをダウンロードします。
.zip ファイルを解凍し、
dotnet-docs-samples-master\endpoints\getting-startedディレクトリに移動します。GettingStarted.slnを Visual Studio で開きます。あるいは、いつも使っているエディタでendpoints\getting-started\src\IO.Swaggerディレクトリにあるファイルを編集します。
Endpoints の設定
サンプルコードには、OpenAPI 構成ファイル openapi-appengine.yaml が含まれています。このファイルは OpenAPI 仕様 v2.0 に準拠しています。
- サンプルコードのディレクトリで、
openapi-appengine.yaml構成ファイルを開きます。次の点にご注意ください。
- 上記の構成サンプルでは
hostフィールドの近辺に表示されている行を変更する必要があります。openapi-appengine.yamlを Endpoints にデプロイするには、完全な OpenAPI ドキュメントが必要です。 - サンプル
openapi-appengine.yamlには、このチュートリアルでは不要な認証を構成するためのセクションが含まれています。YOUR-SERVICE-ACCOUNT-EMAIL と YOUR-CLIENT-ID の行を構成する必要はありません。 - OpenAPI は言語に依存しない仕様です。利便性を考慮し、各言語の GitHub リポジトリで、同じ
openapi-appengine.yamlファイルがgetting-startedサンプル内に用意されています。
- 上記の構成サンプルでは
hostフィールドのある行で、YOUR-PROJECT-ID を Google Cloud プロジェクト ID に置き換えます。例:host: "example-project-12345.appspot.com"
Endpoints は、host フィールドに構成されたテキストをサービス名として使用します。App Engine バックエンドに API をデプロイすると、YOUR-PROJECT-ID.appspot.com という形式の名前を持つ DNS エントリが自動的に作成されます。
Endpoints に必要な OpenAPI ドキュメントのフィールドについては、Endpoints を構成するをご覧ください。
Endpoints 構成をデプロイする
Endpoints の構成をデプロイするには、gcloud endpoints
services deploy コマンドを使用します。このコマンドを実行すると、Service Management を使用してマネージド サービスが作成されます。
Endpoints 構成をデプロイするには:
endpoints/getting-startedディレクトリ内にいることを確認します。- 構成をアップロードしてマネージド サービスを作成します。
gcloud endpoints services deploy openapi-appengine.yaml
gcloud コマンドが Service Management API を呼び出して、openapi-appengine.yaml ファイルの host フィールドで指定した名前のマネージド サービスを作成します。Service Management は、openapi-appengine.yaml ファイル内の設定に従ってサービスを構成します。openapi-appengine.yaml に変更を加えるときは、このファイルを再デプロイして Endpoints サービスを更新する必要があります。
Service Management でサービスの作成と構成が行われるとき、情報がターミナルに出力されます。openapi-appengine.yaml ファイル内のパスが API キーを要求していないことを示す警告は無視して問題ありません。サービスの構成が完了すると、Service Management に、次のようなサービス構成 ID とサービス名を含むメッセージが表示されます。
Service Configuration [2017-02-13r0] uploaded for service [example-project-12345.appspot.com]
上記の例では、2017-02-13r0 はサービス構成 ID、example-project-12345.appspot.com は Endpoints サービスです。サービス構成 ID は、日付スタンプとそれに続くリビジョン番号で構成されます。同じ日に openapi-appengine.yaml ファイルを再度デプロイすると、サービス構成 ID のリビジョン番号が増分されます。Endpoints のサービス構成は、Google Cloud コンソールの [Endpoints] > [サービス] ページで確認できます。
エラー メッセージが表示された場合は、Endpoints 構成のデプロイのトラブルシューティングをご覧ください。
必要なサービスの確認
Endpoints と ESP を使用するには、少なくとも次の Google サービスの有効化が必要です。| 名前 | タイトル |
|---|---|
servicemanagement.googleapis.com |
Service Management API |
servicecontrol.googleapis.com |
Service Control API |
endpoints.googleapis.com |
Google Cloud Endpoints |
ほとんどの場合、gcloud endpoints services deploy コマンドによってこれらの必須サービスが有効化されます。ただし、以下の状況では、gcloud コマンドは正常に完了しますが、必須サービスが有効になりません。
Terraform などのサードパーティのアプリケーションを使用していて、上記のサービスを含めていない場合。
上記のサービスが明示的に無効にされている既存の Google Cloud プロジェクトに Endpoints 構成をデプロイした場合。
必要なサービスが有効になっていることを確認するには、次のコマンドを実行します。
gcloud services list
必要なサービスが表示されない場合は、次のコマンドを使用してサービスを有効にします。
gcloud services enable servicemanagement.googleapis.comgcloud services enable servicecontrol.googleapis.comgcloud services enable endpoints.googleapis.com
Endpoints サービスも有効にします。
gcloud services enable ENDPOINTS_SERVICE_NAME
ENDPOINTS_SERVICE_NAME を確認するには、次のいずれかを行います。
Endpoints 構成をデプロイ後、Cloud Console の [Endpoints] ページに移動します。[サービス名] 列に、考えられる ENDPOINTS_SERVICE_NAME のリストが表示されます。
OpenAPI の場合、ENDPOINTS_SERVICE_NAME は OpenAPI 仕様の
hostフィールドで指定したものです。gRPC の場合、ENDPOINTS_SERVICE_NAME は gRPC Endpoints 構成のnameフィールドで指定したものです。
gcloud コマンドの詳細については、gcloud サービスをご覧ください。
API バックエンドをデプロイする
ここまでの手順で OpenAPI ドキュメントを Service Management にデプロイしましたが、API バックエンドを処理するコードはまだデプロイしていません。ここでは、サンプル API と ESP を App Engine にデプロイします。
API バックエンドをデプロイするには:
endpoints/getting-started/src/IO.Swagger/app.yamlファイルを開き、サービス名を追加します。app.yamlファイルを保存します。openapi-appengine.yaml構成ファイルがあるendpoints/getting-startedディレクトリにいることを確認します。- サンプル API と ESP を App Engine にデプロイします。
ENDPOINTS-SERVICE-NAME を Endpoints サービスの名前で置き換えます。これは、OpenAPI ドキュメントの host フィールドで構成した名前と同じです。例:
endpoints_api_service: name: example-project-12345.appspot.com rollout_strategy: managed
rollout_strategy: managed オプションを指定すると、デプロイ済みの最新のサービス構成を使用するように ESP が構成されます。このオプションを指定すると、新しいサービス構成をデプロイしてから 5 分以内に ESP が変更を検出し、自動的に使用します。ESP が特定の構成 ID でなく、このオプションを使用するようにしてください。
endpoints_api_service セクションが app.yaml ファイルに含まれているため、gcloud app deploy コマンドは ESP を App Engine フレキシブル環境の別のコンテナにデプロイして構成します。すべてのリクエスト トラフィックは ESP 経由でルーティングされ、ESP はバックエンド サーバーコードを実行するコンテナとの間でリクエストとレスポンスの送受信を行います。
dotnet restore
dotnet publish
gcloud app deploy src\IO.Swagger\bin\Debug\netcoreapp2.0\publish\app.yaml
gcloud app deploy コマンドは、YOUR_PROJECT_ID.appspot.com という形式の DNS レコードを作成しますが、これは API にリクエストを送信するときに使用します。App Engine が完全に初期化される間、API にリクエストを送信するまで数分待つことをおすすめします。
エラー メッセージが表示された場合は、App Engine フレキシブル環境でのデプロイのトラブルシューティングをご覧ください。
詳しくは、API バックエンドをデプロイするをご覧ください。
API にリクエストを送信する
サンプル API をデプロイしたら、API にリクエストを送信します。
API キーを作成し、環境変数を設定する
サンプルコードには API キーが必要です。リクエストを簡単にするために、API キーの環境変数を設定します。
API に使用したものと同じ Google Cloud プロジェクトの API 認証情報ページで API キーを作成します。別の Google Cloud プロジェクトで API キーを作成するには、Google Cloud プロジェクトでの API の有効化をご覧ください。
- [認証情報を作成] をクリックして [API キー] を選択します。
- キーをクリップボードにコピーします。
- [閉じる] をクリックします。
- ローカル PC で、API キーを貼り付けて環境変数に割り当てます。
$Env:ENDPOINTS_KEY="AIza..."
リクエストを送信する
PowerShell で、App Engine プロジェクト URL の環境変数を設定します。YOUR_PROJECT_ID を実際の Google Cloud プロジェクト ID に置き換えます。
$Env:ENDPOINTS_HOST="https://YOUR_PROJECT_ID.appspot.com"設定済みの
ENDPOINTS_HOST環境変数とENDPOINTS_KEY環境変数を使用して、HTTP リクエストをテストします。Invoke-WebRequest "$ENDPOINTS_HOST/echo?key=$ENDPOINTS_KEY" ` -Body '{"message": "hello world"}' -Method POST ` -ContentType "application/json"
上記の例では、最初の 2 行はバッククォートで終わります。この例を PowerShell に貼り付けるとき、バッククォートの後にスペースがないことを確認してください。このリクエスト例で使用されているオプションについては、Microsoft のドキュメントの Invoke-WebRequest をご覧ください。
API によって送信メッセージがエコーバックされ、次のようなレスポンスが返されます。
{
"message": "hello world"
}
正常なレスポンスが返されなかった場合は、レスポンス エラーのトラブルシューティングをご覧ください。
これで Endpoints の API のデプロイとテストが完了しました。
API の活動を追跡する
[エンドポイント] ページで API のアクティビティ グラフを確認します。
グラフにリクエストが反映されるまでしばらくかかります。
[ログ エクスプローラ] ページで API のリクエスト ログを確認します。
API のデベロッパー ポータルを作成する
Cloud Endpoints Portal を使用してデベロッパー ポータルを作成できます。デベロッパー ポータルとは、サンプル API の操作に使用できるウェブサイトです。詳細については、Cloud Endpoints Portal の概要をご覧ください。
クリーンアップ
このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、リソースを含むプロジェクトを削除するか、プロジェクトを維持して個々のリソースを削除します。
このチュートリアルで使用したサービスを停止するには、API と API インスタンスを削除するをご覧ください。