メニュー
Amazon API Gateway
開発者ガイド

Amazon API Gateway での API の作成

Amazon API Gateway では、API Gateway リソースと呼ばれるプログラム可能なエンティティのコレクションを使用して API を構築します。たとえば、RestApi リソースを使用してリソースエンティティのコレクションを含むことができる API を表します。各 Resource エンティティは、メソッドリソースを 1 つ以上持つことができます。リクエストパラメーターと本文で表された Method は、クライアントが公開された Resource にアクセスするためのアプリケーションプログラミングインターフェイスを定義し、クライアントによって送信された受信リクエストを表します。その後、Integration リソースを作成し、受信リクエストを指定の統合エンドポイント URI に転送することにより、統合エンドポイントとも呼ばれるバックエンドエンドポイントと Method を統合します。必要に応じて、バックエンド要件を満たすようにリクエストパラメーターや本文を変換します。レスポンスでは、MethodResponse を作成してクライアントが受信するリクエストを表し、IntegrationResponse リソースを作成してバックエンドから返されるリクエストレスポンスを表すことができます。統合レスポンスを設定し、データがクライアントに返される前にバックエンドレスポンスデータを変換するか、バックエンドレスポンスをそのままクライアントにパスすることができます。

ユーザーが API を理解しやすいように、API 作成の一環として、または API 作成後に API のドキュメントを提供することもできます。これを行うには、サポートされている API エンティティに DocumentationPart リソースを追加します。

クライアントが API を呼び出す方法を管理するには、IAM 権限カスタムオーソライザー、または Amazon Cognito ユーザープールを使用します。API の使用を計測するには、API リクエストを調整するように usage plans を設定します。これらは、API の作成または更新時に有効化できます。

API Gateway コンソール、API Gateway REST API、AWS CLI、または AWS SDK のいずれかを使用して、これらのタスクや他のタスクを実行できます。次のこれらのタスクを実行する方法を説明します。

API Gateway API をセットアップするエンドポイントタイプを選択する

API エンドポイント は、API のホスト名を参照します。API エンドポイントは、API トラフィックの大部分の発信元となっている場所に応じて、エッジ最適化される場合があります。API を作成する際は特定のエンドポイントタイプを選択します。

エッジ最適化された API エンドポイントは、地理的に分散するクライアントによる Amazon CloudFront ディストリビューションを通した API へのアクセスを最適化します。API リクエストは、最寄りの CloudFront 接続ポイント (POP) にルーティングされます。デフォルトでは、API はエッジ最適化されたエンドポイントで作成されます。

リージョン別 API は同じリージョンのクライアントを対象としています。EC2 インスタンスで実行されているクライアントが同じリージョンの API を呼び出す場合、または API が要求の高い少数のクライアントへのサービスを目的としている場合、リージョン別 API は接続のオーバーヘッドを減らします。

エッジ最適化された API では、すべてのリージョンに適用されるカスタムドメイン名を作成します。リージョン別 API では、API をホストしているリージョンに固有のカスタムドメイン名を作成します。異なるリージョンにデプロイされたリージョン別 API が同じカスタムドメイン名を持つ場合があります。