【5分でわかる】API Gatewayの概要と使い方

この記事では、Google Cloud Platform（GCP）のGoogle Cloud API Gatewayについて詳しく解説します。5分で基本的な概要と使い方理解し、チュートリアルを通して実践的なスキルを磨いていきましょう！

想定している読者

Google Cloud API Gatewayを実際に動かしながら理解したい方

筆者について

GCP認定資格プロフェッショナル Cloud Architect 取得済

エンジニアとして5年間GCPを現役で利用

Google Cloud API Gatewayとは

Google Cloud API Gatewayの主な特徴と機能
Google Cloud API Gatewayの基本的な使い方
事前準備
チュートリアル:Google Cloud API Gatewayをデプロイする
Cloud FunctionsでAPIを作成/デプロイする
API Gatewayを作成する
まとめ：API Gatewayを使いこなそう！
もっとGCPを極めたい方は参考ください！

Google Cloud API Gatewayとは

Google Cloud API Gatewayは、Google Cloud Platform (GCP) のサービスの一部で、APIのデプロイ、セキュア、監視、およびスケールのための完全に管理されたサービスです。開発者はこのサービスを使用して、エンドポイントのセキュリティを簡単に保護し、トラフィックを制御し、APIの使用を分析することができます。

筆者

簡単にAPIのGatewayシステムを構築できます

Google Cloud API Gatewayの主な特徴と機能

Google Cloud API Gatewayの主な特徴と機能は以下になります。

APIエンドポイントへのアクセスをセキュアに制御

OAuth 2.0トークン検証やAPIキーの使用を通じて、APIエンドポイントへのアクセスをセキュアに制御することができます。

トラフィック制御

APIへのリクエスト数を制限するためのクオータ管理や、異常なトラフィックの検出などの機能を提供しています。

監視とログ

Google Cloud’s Operations Suite (以前はStackdriverとして知られていました) との統合により、APIのパフォーマンスの監視やログの収集が簡単に行えます。

OpenAPI Specificationのサポート

開発者はOpenAPIの仕様を使用してAPIを定義し、その仕様を基にAPI Gatewayをデプロイすることができます。

複数のバックエンドサポート

Cloud Functions, Cloud Run, App Engineなど、様々なGoogle CloudのサービスをAPIのバックエンドとして接続できます。

フルマネージド

API Gatewayはサーバーレスであり、スケーリングやインフラの管理を気にすることなく、APIをデプロイと運用することができます。

筆者

無料枠も豊富で個人開発でも重宝しています！

Google Cloud API Gatewayの基本的な使い方

ここから実際にGoogle Cloud API Gatewayに触れながら機能を理解していきましょう。

具体的な手順について説明していきたいと思います。

事前準備

今回の手順以下の作業が全て完了している前提で進めていきます。

Googleアカウントの取得
GCPへ初回ログイン済

チュートリアル:Google Cloud API Gatewayをデプロイする

今回は、コンソールなどを使用せずGCPの画面操作のみで、Google Cloud API Gatewayをデプロイしてみましょう。

今回のチュートリアルは2023年9月時点のGCPを利用しています。最新のGCPのバージョンからUIの変更がされている可能性がございますのでご注意ください

今回はバックエンドのAPIをCloud Functionsでデプロイし、そのAPIとGoogle Cloud API Gatewayを接続するようなアーキテクチャを実現してみます。

Cloud FunctionsでAPIを作成/デプロイする

まずはCloud FunctionsでAPIを作成し、デプロイします。

1. Cloud Functionsにアクセスする

検索窓から「Cloud Functions」と入力し、出てきた選択肢を押下します。

2. ファンクションを作成する

「ファンクションを作成」ボタンを押下します

初めてCloud Functionsを利用する場合は、以下のような画面で他APIの利用許可を求められるので「有効にする」を選択してください。

3.ファンクションの設定をする

ファンクションの詳細設定を行います。

今回は以下のように設定しました。

項目名	概要	今回の設定値
関数名	ファンクションに任意の名前を設定	demo-function-1
リージョン	ファンクションを置いておく場所	asia-northeast1
認証	APIを実行する際に認証を必要とするか設定	未認証の呼び出しを許可

他入力項目については今回特別変更を加える必要はありません。全てデフォルトの値を設定します。

「次へ」ボタンを押下します。

初めてCloud Functionsを利用する場合は、再度以下のような画面で他APIの利用許可を求められるので「有効にする」を選択してください。

4. 実行するファンクションのランタイムと処理内容を設定する

今回はPythonを利用したかったのでランタイムはPython 3.11を設定しました。

ソースコードはデフォルトのもので問題ありません。今回はAPIコールをしたらHello Worldという文字列が表示される処理内容となっています。

最後に「デプロイ」ボタンを押下します。

これでAPIがデプロイされました。(デプロイまで数分待ちます)

5 . APIをコールしてみる

早速、デプロイされたAPIをコールしてみましょう。

以下の部分よりURLを確認して押下してください。

すると以下のようにHello Worldという文字列が表示されるかと思います。

これで正常にデプロイと処理内容が実行されていることが確認できました。

API Gatewayを作成する

では本題のAPI Gatewayを使ってみましょう！

1. API Gatewayにアクセスする

API Gatewayにアクセスするには、コンソールの検索窓に「API Gateway」と入力すれば選択肢が表示されますのでそちらを押下してください

初めてAPI Gatewayを利用した方は以下のようなダイアログが表示されますので「LAUNCH」を押下して全てのAPIを実行可能な状態にしましょう。

各画面で「有効にする」ボタンが表示されますので、そちらを押下してください。すると前の画面に戻りますので、Service Control APIの方も同じように有効にしていきます。

2. API Gatewayの作成

API Gatewayのホーム画面に遷移しますので、そこから「ゲートウェイを作成」ボタンを押下します。

次にAPIの設定を行います。

今回、API構成の項目については以下のように設定しました

項目	設定する値
構成を選択	新しいAPI構成の作成
API使用をアップロード	参照ボタンを押下してファイルをアップロードする
表示名	demo-api
サービスアカウントを選択	App Engine default service account

アップロードするファイルについてですが、openapi2-functions.yamlという名前で以下の内容を設定してアップロードします。

# openapi2-functions.yaml
swagger: '2.0'
info:
  title: demo-api
  description: Sample API on API Gateway with a Google Cloud Functions backend
  version: 1.0.0
schemes:
  - https
produces:
  - application/json
paths:
  /hello:
    get:
      summary: Greet a user
      operationId: hello
      x-google-backend:
        address: //Cloud Functions でデプロイしたAPIのURLを設定する
      responses:
        '200':
          description: A successful response
          schema:
            type: string

特に意識していただきたいのでは、以下の赤枠の部分です。