Amazon API Gateway のよくある質問

Amazon API Gateway は、開発者があらゆる規模で API の公開、保守、モニタリング、セキュリティ保護を簡単に行えるフルマネージドサービスです。AWS マネジメントコンソールで数回クリックするだけで、Amazon Elastic Compute Cloud (Amazon EC2)、Amazon Elastic Container Service (Amazon ECS)、AWS Elastic Beanstalk で稼働中のアプリケーション、AWS Lambda で稼働中のコード、または任意のウェブアプリケーションといった、お客様のバックエンドサービスのデータやビジネスロジック、および機能にアクセスする、アプリケーションの "正面玄関" となる API を作成できます。Amazon API Gateway では、最大数十万の同時 API 呼び出しを受け付け、処理することが可能です。これにはトラフィック管理、認証とアクセス管理、モニタリング、API バージョン管理が含まれます。Amazon API Gateway に最低料金や初期費用は発生しません。HTTP API および REST API に関しては、受信した API コール数と、転送データ量に対してのみ料金が発生します。WebSocket API に関しては、送受信されたメッセージと、ユーザーデバイスの WebSocket API への接続時間に対してのみ料金が発生します。

Amazon API Gateway はシンプルかつ柔軟な全面的に管理された従量制のサービスで、アプリケーションのバックエンド用の堅牢な API の作成と運用に関するすべての側面を扱います。API Gateway を使用すれば、より少ない投資で、いっそうスピーディーに新しいサービスを立ち上げることができるので、中核となるビジネスサービスの構築に集中できます。API Gateway は、API を作成し、管理するための次のような側面をサポートするように構築されています。

1) 計測。API Gateway により、API へのサードパーティデベロッパーのアクセスを計測および制限するプランを定義できます。API キーごとにプランセットを定義し、スロットリングとクォータ制限を設定できます。API Gateway では、自動的に API へのトラフィックが計測され、各 API キーの使用率データを抽出できます。

2) セキュリティ。API Gateway には、お客様の API に対するアクセスを認証し、サービスを操作するアクセスを管理する、複数のツールが準備されています。API Gateway では、AWS Identity and Access Management (IAM)、Amazon Cognito といった AWS の管理ツールやセキュリティツールを使用して、API に対するアクセス認証を実施できます。API Gateway では、AWS が自身の API に使用しているのと同じ方法を使用して、お客様に代わって署名付き API コールを検証できます。また、API Gateway では、AWS Lambda の機能として記述されたカスタムオーソライザーを使用して、受信するベアラートークンを検証することもでき、バックエンドコードでの認証に関する懸念を解消できます。

3) 回復力。API Gateway はスロットリングによってトラフィックを管理できるので、バックエンド動作はトラフィックの激増に耐えられます。また、API Gateway は API コールに対する出力をキャッシュし、バックエンドシステムへの不要な呼び出しを避けることによって、お客様の API のパフォーマンスとエンドユーザーエクスペリエンスの向上に貢献します。

4) オペレーションのモニタリング。API が公開され、使用状態になると、API Gateway ではメトリクスを表示するダッシュボードによって、サービスの呼び出しをモニタリングできます。API Gateway ダッシュボードでは、Amazon CloudWatch との統合によって、API 呼び出し、レイテンシーデータ、エラー率といったバックエンドのパフォーマンスメトリクスを確認できます。お客様の API の各メソッドについてより詳細なメトリクスを取得できるようにすることや、エラーログ、アクセスログ、デバッグログを CloudWatch のログに記録させることも可能です。

5) ライフサイクル管理。API を公開した後には、機能の強化や追加を実施した新しいバージョンを構築し、テストすることがしばしば必要となります。API Gateway では、複数のバージョンの API、および各バージョンのさまざまなステージのものを同時に動作させることができるため、新しい API バージョンの公開後にも既存アプリケーションに引き続き以前のバージョンを使用させることが可能です。

6) デベロッパー向けの設計。API Gateway では、API をすばやく作成し、静的なコンテンツをレスポンスとして割り当てることができるため、アプリケーションのためのクロスチームによる開発の労力や販売までの時間を少なくすることができます。バックエンドプロセスがまだ構築中であるときに、お客様の API に依存するチームが開発を開始することも可能です。

7) リアルタイム双方向通信。 チャットアプリ、ストリーミングダッシュボード、通知といったリアルタイム双方向通信アプリケーションを構築します。サーバーの起動や管理にわずらわされることもなくなります。API Gateway は接続されたユーザー間の永続的な接続を維持し、メッセージの転送ができます。

Amazon API Gateway では、WebSocket API を作成するオプションに加えて、RESTful API を作成する 2 つのオプション (HTTP API および REST API) を提供します。

HTTP API: HTTP API は、AWS Lambda 関数または HTTP バックエンドにプロキシする API を構築するために最適化されており、サーバーレスワークロードに最適です。現在 API 管理機能は提供されていません。

REST API: REST API は、単一のソリューションで API プロキシの機能と管理機能を提供します。 REST API は、利用プラン、API キー、API の公開と収益化などの API 管理機能を提供します。

WebSocket API: WebSocket API は接続クライアントとの間に永続的な接続を維持して、メッセージのリアルタイムでの送受信を可能にします。API Gateway の WebSocket API を使用すれば、接続したクライアントからのメッセージを受信した際に呼び出される AWS Lambda 関数、Amazon Kinesis、または任意の HTTP エンドポイントとのバックエンドでの連携を定義することができます。

HTTP API の使用を開始するには、Amazon API Gateway コンソール、AWS CLI、AWS SDK、または AWS CloudFormation を利用できます。HTTP API の開始方法の詳細については、ドキュメントを参照してください。

REST API の使用を開始するには、Amazon API Gateway コンソール、AWS CLI、または AWS SDK を利用できます。REST API の開始方法の詳細については、ドキュメントを参照してください。

Amazon API Gateway では HTTP API と REST API の両方を使用して RESTful API を作成できます。

HTTP API は、AWS Lambda 関数または HTTP バックエンドにプロキシする API を構築するために最適化されており、サーバーレスワークロードに最適です。HTTP API は REST API に比べて安価で高速な代替手段ですが、現在 API 管理機能をサポートしていません。REST API は、単一のソリューションで API プロキシ機能と API 管理機能を必要とする API が対象になります。

HTTP API は次のような場合に適しています。

1. AWS Lambda または HTTP エンドポイント用のプロキシ API を構築する
2. OIDC および OAuth2 の認証を備えた最新の API を構築する 
3. 非常に大規模になる可能性があるワークロード
4. レイテンシーに敏感なワークロード用の API

1. API の構築、管理、公開に必要なすべての機能が含まれているセットに対して単一価格の支払いを希望されるお客様。 

HTTP API では、CORS サポート、認証および許可での OIDC と OAuth2 のサポート、および段階的な自動デプロイが標準で提供されます。

はい。OpenAPI 3 を使用して API 定義をインポートできます。これにより、ルート、統合、および API モデルが作成されます。OpenAPI 定義のインポートについて詳しくは、ドキュメントをご覧ください。

Amazon API Gateway で現行の REST API から HTTP API に移行するには、次のようにします。

1. 必要な機能がすべて HTTP で利用できることを確認します。完全な機能のリストを確認するには、ドキュメントをご覧ください。 
2. 対象の REST API に移動し、REST API から OpenAPI 定義をエクスポートします
3. 対象の HTTP API に移動し、前のステップで取得した OpenAPI 定義をインポートします
4. API の機能が想定通りであることをテストします
5. クライアントを新しい URL で更新します

API は動作する場合もありますが、欠落している機能に気が付く場合もあります。欠落している機能がないか確認するために、インポートオペレーションの [情報]、[警告]、および [エラー] の各フィールドを確認してください。REST API の HTTP API への移行の詳細については、ドキュメントをご覧ください。

最初に、対象の REST に移動し、REST API から OpenAPI 定義をエクスポートします。次に、対象の HTTP API に移動し、前のステップで取得した OpenAPI 定義をインポートします。API は動作する場合もありますが、欠落している機能に気が付く場合もあります。欠落している機能がないか確認するために、インポートオペレーションの [情報]、[警告]、および [エラー] の各フィールドを確認してください。AWS CLI は API に関する情報を情報フィールドと警告フィールドに返します。詳細については、ドキュメントをご覧ください。

使用を開始するには、AWS マネジメントコンソール、AWS CLI または AWS SDK を使用して WebSocket API を作成します。それから WebSocket のルーティングを設定し、AWS Lambda、 Amazon Kinesis、 HTTP エンドポイントなどのバックエンドサービスがメッセージの内容に基づいて呼び出されるように指定できます。API Gateway の WebSocket API の使用を開始するには、ドキュメントを参照してください。

はい。Amazon API Gateway で作成された API はすべて、HTTPS エンドポイントのみ公開します。Amazon API Gateway は非暗号化 (HTTP) エンドポイントをサポートしません。デフォルトでは、自動的に Amazon API Gateweay 証明書を使用する API に対して、Amazon API Gateway によって内部ドメインが割り当てられます。お客様の API をカスタムドメイン名で動作するよう設定する場合、そのドメイン用にお客様自身の証明書を指定できます。

Amazon API Gateway で構築される API は、HTTP API、REST API、および WebSocket API 向けの HTTPS を介して送られるどのようなペイロードも受け入れ可能です。代表的なデータフォーマットには JSON、XML、クエリ文字列パラメータ、リクエストヘッダーなどがあります。お客様の API に対するレスポンスとしてあらゆるコンテンツタイプを宣言することが可能です。さらに、変換テンプレートによってバックエンドからのレスポンスを必要なフォーマットに変換できます。

Amazon API Gateway では、アカウントで AWS Lambda 関数を実行したり、AWS Step Functions ステートマシンを起動できるほか、AWS Elastic Beanstalk や Amazon EC2 上でホストされる HTTP エンドポイントや、パブリックインターネット経由でアクセスできる非 AWS でホストされている HTTP ベースのオペレーションを呼び出すことができます。また、Gateway では、マッピングテンプレートを指定して、返る静的コンテンツを生成することもできるため、バックエンドの準備が整う前に API をモックすることができます。API Gateway を AWS の他のサービスに直接統合することもできます。例えば、データを Amazon Kinesis に直接送信する API メソッドを API Gateway で表示できます。

API Gateway では、Android および iOS (Swift と Objective-C) を使用したモバイルアプリケーション開発向けのカスタム SDK や、JavaScript を使用したウェブアプリケーション開発向けのカスタム SDK を生成できます。また、Ruby や Java 向けの SDK も生成できます。API とそのモデルが API Gateway で定義されると、AWS コンソールや API Gateway の API を使用して、クライアント SDK の生成とダウンロードを実行できます。Client SDK は Amazon API Gateway の REST API に対してのみ生成されます。

HTTP API、REST API、WebSocket API がどこで利用できるか確認するには、こちらで AWS リージョンのテーブルをご覧ください。

Amazon API Gateway コンソールによって、REST API およびそれに関連付けられたリソースとメソッドを定義し、API のライフサイクルを管理し、クライアント SDK を生成し、API メトリクスを参照することができます。また、API Gateway コンソールを使用して、API の利用プランを定義し、デベロッパーの API キーを管理し、そしてスロットリングとクォータ制限を設定できます。同様のアクションはすべて、API Gateway API を介しても実行できます。

リソースとは、お客様の API のドメインの一部である、型付きオブジェクトです。各リソースには関連するデータモデル、他のリソースへの関連があり、異なる方法に応答できます。リソースを変数として定義して、複数の子リソースへのリクエストをインターセプトすることもできます。

REST API 内部の各リソースは、1 つ以上の標準 HTTP メソッドをサポートできます。それぞれのリソースに対してサポートされることが必要な動詞 (GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS) と、その実装を定義します。たとえば、cars リソースに対する GET は車のリストを返すはずです。リソース内のすべてのメソッドをバックエンドの単一のエンドポイントに関連付けるには、API Gateway が特別な "ANY" メソッドもサポートしている必要があります。

使用量プランにより、サードパーティーデベロッパーのプランを宣言することで、アクセスを特定の API に制限し、スロットリングとリクエストクォータ制限を定義して、API キーに関連付けることができます。また、API キーごとに使用率のデータを抽出して API の使用状況を分析したり、請求用のドキュメントを生成することもできます。使用量プランは、ベーシック、プロフェッショナル、エンタープライズなどを作成できます。例えば、最大値を 1 日あたり 1,000 件のリクエストと毎秒 5 件のリクエスト (RPS) に設定したベーシックな使用量プランなどを作成できます。

Amazon API Gateway では、それぞれの REST API に複数のステージを持たせることができます。ステージは、API の開発ライフサイクルを助けることを意図したものです。例えば、API を構築してから開発ステージにデプロイすることや、製品版としての準備ができたときに本番ステージにデプロイすることができます。

Amazon API Gateway のステージは、タグに似ています。ステージは、デプロイ環境からアクセス可能なパス経路を定義します。例えば、開発ステージを定義し、お客様の cars API をそこにデプロイできます。このリソースは、https://www.myapi.com/dev/cars でアクセスできるようになります。カスタムドメイン名を設定してステージを直接指示すれば、パスパラメータの追加を不要にすることも可能です。例えば、myapi.com を直接開発ステージに指定した場合、cars リソースには https://www.myapi.com/cars でアクセスできます。ステージは、API コンフィギュレーションまたはマッピングテンプレートからアクセスできる変数を使って設定できます。

ステージ変数を使うと、ステージに関連した設定値のキー/値ペアを定義できます。この値は環境変数に似ており、ユーザーの API コンフィギュレーションで使用できます。例えば、ステージ変数としてメソッド統合の HTTP エンドポイントを定義し、エンドポイントをハードコーディングする代わりにその変数を API コンフィギュレーションで使用することができます。こうすると、同じ API コンフィギュレーションを使って各ステージ (dev、beta、prod など) に異なるエンドポイントが使用できるようになります。ステージ変数はマッピングテンプレートでもアクセスでき、これを使用して設定パラメータをお客様の Lambda または HTTP バックエンドに渡すことができます。

リソースポリシーは、指定されたプリンシパル (通常、IAM ユーザーまたはロール) による API 呼び出しを可能にするかどうかを制御するために、ユーザーが API にアタッチする JSON ポリシードキュメントです。リソースポリシーを使用すると、異なる AWS アカウントのユーザーからの API への安全なアクセスを有効にすることや、指定されたソース IP アドレス範囲または CIDR ブロックのみから API を呼び出せるようにすることが可能になります。リソースポリシーは Amazon API Gateway の REST API で使用できます。

Amazon API Gateway には、デプロイの履歴が保存されます。どの時点でも、Amazon API Gateway の API またはコンソールを使用することで、ステージを以前のデプロイにロールバックさせられます。

はい。オープンソースの Swagger インポートツール を使用すれば、自作の Swagger API 定義を Amazon API Gateway にインポートできます。Swagger importer tool では、新規の API のデプロイおよび既存の API の更新を実行できます。

API Gateway の自分の API を収益化するには、AWS Marketplace に製品として公開します。まず AWS Marketplace に出品者として登録する必要があります。その後、API Gateway の使用量プランを製品として提出します。API の収益化の詳細については、「こちらを参照してください」。

API Gateway では、メソッドやリソースといった API の各部分に関連付けられたドキュメントの作成、更新、削除を実行できます。ドキュメントに関連付けられた API には、AWS SDK、CLI、RESTful コール経由、または API Gateway コンソールでドキュメント文字列を直接編集することによりアクセスできます。ドキュメントを Swagger ファイルとしてインポートすることも可能です。API の一部としても、個別にもインポートできるため、API の定義に影響を与えずにドキュメントを更新できます。API Gateway は、Swagger ファイルからインポートされた、または Swagger ファイルにエクスポートされたドキュメントのオープン API 仕様に準拠しています。ドキュメントは API ゲートウェイの REST API に向けてサポートされています。

API Gateway では、規格に準拠した API ドキュメントがサポートされているほか、ドキュメントの継承もサポートされているため、ドキュメントの文字列を定義してから、複数の場所で使用することが簡単になります。継承によって API ドキュメントの定義プロセスは簡単になり、Swagger ファイルとして API をエクスポートする場合には標準の表現形式に変換できます。

はい。リソースポリシーを API に適用して、特定の Amazon VPC や Amazon VPC エンドポイントへのアクセスを制限できます。また、リソースポリシーを使用して、異なるアカウントの Amazon VPC や VPC エンドポイントに、プライベート API へのアクセス権を付与することもできます。