Amazon API Gateway
開発者ガイド

Amazon API Gateway で REST API を作成する

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

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

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

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