チェックポイント
Build with Cloud Build
/ 25
REST API Deployed
/ 25
Firestore database created
/ 25
Build image revision 0.2
/ 25
Go と Cloud Run を使用した REST API の開発
GSP761
概要
「Serverless Cloud Run Development」コースのラボでは、架空のビジネス シナリオの登場人物を支援してサーバーレスへの移行計画を進めていきます。
Lily さんは 12 年前、獣医クリニック チェーン「Pet Theory」を開業しました。チェーンが拡大するに伴い、Lily さんはペットの治療よりも、保険会社との電話のやり取りに時間を取られるようになっています。Lily さんは、保険会社が治療の総費用だけをオンラインで確認できるようになればいいのに、と考えています。
このシリーズのラボでは、以前、コンピュータ コンサルタントの Ruby さんと DevOps エンジニアの Patrick さんが Pet Theory の顧客データベースをクラウドでのサーバーレス Firestore データベースに移行し、顧客がデータベースにアクセスしてオンラインで予約を取れるようにしました。しかし Pet Theory の運用チームは 1 人だけなので、継続的なメンテナンスをあまり必要としないサーバーレス ソリューションが求められます。
このラボでは、Ruby さんと Patrick さんの作業をサポートして、顧客の個人情報(PII)を公開せずに、保険会社が顧客データにアクセスできるようにします。サーバーレスの Cloud Run を使用して、安全な Representational State Transfer(REST)API ゲートウェイをビルドします。これにより、顧客の PII を非開示にしたまま、保険会社に治療の総費用を開示できるようになります。
目標
このラボでは、次の作業を行います。
- Go を使用して REST API を開発する
- テスト用の顧客データを Firestore に読み込む
- REST API を Firestore データベースに接続する
- REST API を Cloud Run にデプロイする
前提条件
これは中級レベルのラボです。Cloud コンソール環境と Cloud Shell 環境に精通していることを前提としています。このラボは、シリーズの一部です。次のような先行のラボを受講していれば役立ちますが、必須ではありません。
- サーバーレス データベースへデータを読み込む
- サーバーレス ウェブアプリを Firebase と Firestore でビルドする
- PDF ファイルを作成するサーバーレス アプリをビルドする
設定と要件
[ラボを開始] ボタンをクリックする前に
こちらの手順をお読みください。ラボの時間は記録されており、一時停止することはできません。[ラボを開始] をクリックするとスタートするタイマーは、Google Cloud のリソースを利用できる時間を示しています。
このハンズオンラボでは、シミュレーションやデモ環境ではなく、実際のクラウド環境を使ってご自身でラボのアクティビティを行うことができます。そのため、ラボの受講中に Google Cloud にログインおよびアクセスするための、新しい一時的な認証情報が提供されます。
このラボを完了するためには、下記が必要です。
- 標準的なインターネット ブラウザ(Chrome を推奨)
- ラボを完了するために十分な時間を確保してください。ラボをいったん開始すると一時停止することはできません。
ラボを開始して Google Cloud コンソールにログインする方法
-
[ラボを開始] ボタンをクリックします。ラボの料金をお支払いいただく必要がある場合は、表示されるポップアップでお支払い方法を選択してください。 左側の [ラボの詳細] パネルには、以下が表示されます。
- [Google Cloud コンソールを開く] ボタン
- 残り時間
- このラボで使用する必要がある一時的な認証情報
- このラボを行うために必要なその他の情報(ある場合)
-
[Google Cloud コンソールを開く] をクリックします(Chrome ブラウザを使用している場合は、右クリックして [シークレット ウィンドウでリンクを開く] を選択します)。
ラボでリソースが起動し、別のタブで [ログイン] ページが表示されます。
ヒント: タブをそれぞれ別のウィンドウで開き、並べて表示しておきましょう。
注: [アカウントの選択] ダイアログが表示されたら、[別のアカウントを使用] をクリックします。 -
必要に応じて、下のユーザー名をコピーして、[ログイン] ダイアログに貼り付けます。
{{{user_0.username | "Username"}}} [ラボの詳細] パネルでも [ユーザー名] を確認できます。
-
[次へ] をクリックします。
-
以下のパスワードをコピーして、[ようこそ] ダイアログに貼り付けます。
{{{user_0.password | "Password"}}} [ラボの詳細] パネルでも [パスワード] を確認できます。
-
[次へ] をクリックします。
重要: ラボで提供された認証情報を使用する必要があります。Google Cloud アカウントの認証情報は使用しないでください。 注: このラボでご自身の Google Cloud アカウントを使用すると、追加料金が発生する場合があります。 -
その後次のように進みます。
- 利用規約に同意してください。
- 一時的なアカウントなので、復元オプションや 2 要素認証プロセスは設定しないでください。
- 無料トライアルには登録しないでください。
その後、このタブで Google Cloud コンソールが開きます。
Cloud Shell をアクティブにする
Cloud Shell は、開発ツールと一緒に読み込まれる仮想マシンです。5 GB の永続ホーム ディレクトリが用意されており、Google Cloud で稼働します。Cloud Shell を使用すると、コマンドラインで Google Cloud リソースにアクセスできます。
- Google Cloud コンソールの上部にある「Cloud Shell をアクティブにする」アイコン をクリックします。
接続した時点で認証が完了しており、プロジェクトに各自の PROJECT_ID が設定されます。出力には、このセッションの PROJECT_ID を宣言する次の行が含まれています。
gcloud
は Google Cloud のコマンドライン ツールです。このツールは、Cloud Shell にプリインストールされており、タブ補完がサポートされています。
- (省略可)次のコマンドを使用すると、有効なアカウント名を一覧表示できます。
-
[承認] をクリックします。
-
出力は次のようになります。
出力:
- (省略可)次のコマンドを使用すると、プロジェクト ID を一覧表示できます。
出力:
出力例:
gcloud
ドキュメントの全文については、gcloud CLI の概要ガイドをご覧ください。
Lily さん(Pet Theory の創業者) |
Ruby さん、こんにちは。 先週、保険会社に関する事務処理や電話でのやり取りに追われていることについて、お話ししました。保険会社の担当者が、安全かつ効率的な方法で、顧客レコードにアクセスできる方法があればいいのに、と思っています。 現状の作業負荷ではこの先、無理が生じてしまいます。アドバイスをいただけませんか? Lily |
Ruby さん(ソフトウェア コンサルタント) |
Lily さん、こんにちは。 先日 Patrick さんとのランチ ミーティングで、承認された第三者が貴社のデジタル レコードに安全かつ簡単にアクセスできる方法について計画を作成しました。 この計画は次の 4 ステップで進めます。
ステップ 1 と 2 についてはすでに見通しが立っていて、順調なスタートといって良いと思います。今週中には実用的なプロトタイプが完成する予定です。 Ruby |
Ruby さんが Pet Theory 用の REST API のビルドに必要なアクティビティを管理する作業をサポートしていきましょう。
タスク 1. Google API を有効にする
このラボでは、2 つの API があらかじめ有効になっています。
名前 | API |
---|---|
Cloud Build | cloudbuild.googleapis.com |
Cloud Run | run.googleapis.com |
タスク 2. REST API を開発する
- プロジェクトを有効にします。
- pet-theory リポジトリのクローンを作成し、ソースコードにアクセスします。
-
使い慣れたテキスト エディタを使うか、Cloud Shell リボンのコードエディタ ボタンを押して、
go.mod
ファイルとgo.sum
ファイルを表示します。 -
ファイル
main.go
を作成し、次のコードをファイルに追加します。
-
Dockerfile
という名前のファイルを作成し、次のコードをファイルに追加します。
ファイル server
は、main.go
からビルドされた実行バイナリです。
- バイナリをビルドするため次のコマンドを実行します。
- ビルドコマンドを実行したら、必要な Dockerfile とサーバーが同じディレクトリ内にあることを確認します。
Cloud Run の Go ベースのアプリの多くでは、通常、上記のようなテンプレート Dockerfile を変更せずに使用できます。
- 次のコードを実行して、シンプルな REST API をデプロイします。
このコマンドによって、コードでコンテナがビルドされ、プロジェクトの Container Registry にコンテナが格納されます。ナビゲーション メニュー > [Container Registry] をクリックすると、コンテナを表示できます。rest-api
が表示されない場合は、[更新] をクリックします。
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
- コンテナがビルドされたら、デプロイします。
- デプロイが完了すると、次のようなメッセージが表示されます。
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
- サービス URL を新しいブラウザタブで開くには、メッセージの最後でサービス URL をクリックします。URL の末尾に「
/v1/
」を追加し、Enter キーを押します。
次のようなメッセージが表示されます。
REST API が稼働するようになりました。プロトタイプ サービスの準備ができたので、次のセクションでは API を使って、Firestore データベースから「顧客」情報を取得します。
タスク 3. 顧客のテストデータを読み込む
Ruby さん(ソフトウェア コンサルタント) |
Patrick さん、こんにちは。 しばらく前に疑似顧客データを作成しましたが、今もお持ちですか?そのデータをテストに利用したいと考えています。 また、Firestore データベースを設定してデータを読み込む方法について、確認しておいてください。 Ruby |
Patrick さん(IT 管理者) |
Ruby さん、こんにちは。 はい、テストデータは今も手元にあります。テストに使えるように、本日中に Firestore に移行しておきます。 Patrick |
Ruby さんと Patrick さんは以前に、顧客 10 人のテスト データベースを作成しました。そこには、ある顧客の猫に対して提案された治療データが入っています。
Patrick さんが Firestore データベースを設定して顧客のテストデータを読み込む作業をサポートしましょう。まず、プロジェクトで Firestore を有効にします。
-
Cloud コンソールに戻り、ナビゲーション メニュー > [Firestore] をクリックします。
-
[データベースを作成] ボタンをクリックします。
-
[ネイティブ モード] ボタンをクリックし、[続行] をクリックします。
-
[ロケーション タイプ] で、[リージョン] を選択します。
-
利用可能なリージョンのリストから
を選択し、[データベースを作成] をクリックします。
データベースが作成されるまで待ってから次に進みます。
[進行状況を確認] をクリックして、上記のタスクを実行したことを確認します。
- あらかじめ用意された Cloud Storage バケットにインポート ファイルを移行します。
- このデータを Firebase に読み込みます。
Cloud コンソール ブラウザを再読み込みして Firestore の結果を確認します。
- Firestore で、「Default」の下にある [顧客] をクリックします。読み込まれたペットデータが表示されるので確認します。データが表示されない場合は、ページを更新してみてください。
Firestore データベースが正常に作成され、テストデータが入力されました。
タスク 4. REST API を Firestore データベースに接続する
Ruby さん(ソフトウェア コンサルタント) |
Lily さん、こんにちは。 取り急ぎ、進捗状況をお知らせします。先日お知らせしたリストのうち、最初の 2 つのタスクを Patrick さんにご協力いただいて完了しました。 次は REST API を構造化して、Firestore の顧客データにアクセスできるようにします。 Ruby |
Lily さん(Pet Theory の創業者) |
Ruby さん、こんにちは。 ご連絡ありがとうございます。次の作業についても、進捗のご報告をお待ちしています。 Lily |
このセクションでは、次のエンドポイントを REST API で作成する Ruby さんの作業をサポートします。
たとえば、この URL では ID 22530 の顧客に関して提案、承認、拒否された治療すべてについて、それぞれの合計金額が(Firestore データベースに存在する場合に)返されます。
この新機能には、Firestore データベースにアクセスするパッケージと、クロスオリジン リソース シェアリング(CORS)を処理するパッケージが必要です。
- $GOOGLE_CLOUD_PROJECT 環境変数の値を取得します。
- pet-theory/lab08 ディレクトリにある
main.go
ファイルを開きます。
- ファイルの内容を以下のコードに置き換えます。
PROJECT_ID
がに設定されていることを確認してください。
- ファイルの末尾に、ハンドラ サポートを追加します。
- ファイルの末尾に、カスタマー サポートを追加します。
- ファイルを保存します。
タスク 6. 理解度テスト
タスク 7. 新しいリビジョンをデプロイする
- ソースコードを再ビルドします。
- REST API の新しいイメージをビルドします。
[進行状況を確認] をクリックして、目標に沿って進んでいることを確認します。
- 更新したイメージをデプロイします。
- すでにその URL で開いてあるブラウザタブに戻ります(末尾に「
/v1
」が付いています)。更新して、API ステータスがまだ実行中であることを示す、以前と同じメッセージが表示されることを確認します。
- ブラウザのアドレスバーに表示されたアプリケーション URL に「
/customer/22530
」を追加します。次の JSON レスポンスを受け取ります。顧客に関して提案、承認、拒否された治療の合計額がそれぞれ表示されるはずです。
- 22530 の代わりに次のような別の顧客 ID を URL に入力してみましょう。
- 34216
- 70156(金額はすべてゼロになります)
- 12345(顧客やペットは存在しないため、Query is nil のようなエラーが返されます)
データベースからの読み取りを行う、スケーラブルでメンテナンスをあまり必要としないサーバーレス REST API をビルドしました。
お疲れさまでした
お疲れさまでした。このラボでは、Ruby さんと Patrick さんが Pet Theory 用のプロトタイプ REST API を正常にビルドできるようにサポートしました。Firestore データベースに接続する REST API を作成し、それを Cloud Run にデプロイしました。また、API をテストして、想定どおりに動作することを確認しました。
Google Cloud トレーニングと認定資格
Google Cloud トレーニングと認定資格を通して、Google Cloud 技術を最大限に活用できるようになります。必要な技術スキルとベスト プラクティスについて取り扱うクラスでは、学習を継続的に進めることができます。トレーニングは基礎レベルから上級レベルまであり、オンデマンド、ライブ、バーチャル参加など、多忙なスケジュールにも対応できるオプションが用意されています。認定資格を取得することで、Google Cloud テクノロジーに関するスキルと知識を証明できます。
マニュアルの最終更新日: 2024 年 5 月 6 日
ラボの最終テスト日: 2024 年 5 月 6 日
Copyright 2024 Google LLC All rights reserved. Google および Google のロゴは Google LLC の商標です。その他すべての企業名および商品名はそれぞれ各社の商標または登録商標です。