API Gateway で REST API を開発する - Amazon API Gateway

API Gateway で REST API を開発する

Amazon API Gateway では、REST API を、API Gateway リソースと呼ばれるプログラム可能なエンティティのコレクションとして構築します。たとえば、RestApi リソースを使用してリソースエンティティのコレクションを含むことができる API を表します。

各 Resource エンティティは、メソッドリソースを 1 つ以上持つことができます。Method は、クライアントから送信された受信リクエストであり、リクエストのパラメータと本文で示されます。これは、公開された Resource にクライアントがアクセスするためのアプリケーションプログラミングインターフェイスを定義します。Method をバックエンドエンドポイント (統合エンドポイントとも呼ばれます) と統合するには、統合リソースを作成します。これにより、受信リクエストが指定先の統合エンドポイント URI に転送されます。必要に応じて、バックエンド要件を満たすようにリクエストのパラメータや本文を変換できます。

レスポンスでは、MethodResponse を作成してクライアントが受信するリクエストを表し、IntegrationResponse リソースを作成してバックエンドから返されるリクエストレスポンスを表すことができます。統合レスポンスを設定し、データがクライアントに返される前にバックエンドレスポンスデータを変換するか、バックエンドレスポンスをそのままクライアントにパスすることができます。

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

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

API の作成方法の概要については、「チュートリアル: Lambda プロキシ統合を使用して REST API を作成する」を参照してください。REST API の開発時に使用できる API Gateway 機能の詳細については、以下のトピックを参照してください。これらのトピックには、概念情報に加えて、API Gateway コンソール、API Gateway REST API、AWS CLI、またはいずれかの AWS SDK を使用して実行できる手順が含まれています。

トピック