API Gateway での HTTP API の開発
このセクションでは、API Gateway API の開発中に必要な API Gateway 機能について詳しく説明します。
API Gateway API の開発中、API の特性をいくつか決定することになります。これらの特性は API のユースケースによって異なります。たとえば、API を特定のクライアントのみが呼び出せるようにしたり、すべてのユーザーが利用できるようにしたりできます。API コールで Lambda 関数の実行、データベースクエリの作成やアプリケーションの呼び出しができます。
トピック
HTTP API の作成
機能する API を作成するには、少なくとも 1 つのルート、統合、ステージ、およびデプロイが必要です。
次の例は、AWS Lambda または HTTP 統合、ルート、および変更を自動的にデプロイするように設定されたデフォルトステージを持つ API を作成する方法を示しています。
このガイドは、ユーザーが既に API Gateway と Lambda に関する知識を持っていることを前提としています。より詳細なガイドについては、「API Gateway の開始方法」を参照してください。
を使用して HTTP API を作成するAWS Management Console
-
API Gateway コンソール
を開きます。 -
[Create API] を選択します。
-
[HTTP API] で、[Build (ビルド)] を選択します。
-
[統合の追加] を選択し、AWS Lambda 関数を選択するか、HTTP エンドポイントを入力します。
-
[Name (名前)] に、API の名前を指定します。
-
[Review and create] を選択します。
-
[Create] を選択します。
これで、API を呼び出す準備ができました。API をテストするには、呼び出し URL をブラウザに入力するか、Curl を使用します。
curl https://api-id.execute-api.us-east-2.amazonaws.com
AWS CLI を使用して HTTP API を作成する
クイック作成を使用して、Lambda または HTTP 統合、デフォルトのキャッチオールルート、変更を自動的にデプロイするように設定されたデフォルトステージを持つ API を作成できます。次のコマンドは、クイック作成を使用して、バックエンドで Lambda 関数と統合する API を作成します。
注記
Lambda 統合を呼び出すには、必要なアクセス許可が API Gateway に必要です。リソースベースのポリシーまたは IAM ロールを使用して、Lambda 関数を呼び出す API Gateway のアクセス許可を付与できます。詳細については、AWS Lambda デベロッパーガイドの「AWS Lambda のアクセス許可」を参照してください。
aws apigatewayv2 create-api --namemy-api--protocol-type HTTP --target arn:aws:lambda:us-east-2:123456789012:function:function-name
これで、API を呼び出す準備ができました。API をテストするには、呼び出し URL をブラウザに入力するか、Curl を使用します。
curl https://api-id.execute-api.us-east-2.amazonaws.com
