AWSのsam local start-apiコマンドでイベントファイルを渡したい

ローカル環境でlambdaのコードをnodejsで書いています。

API GATEWAYと連携させて使うため、GETやPUTなどの処理を一つのjsファイルに記載しています。
開発にはsamを使っています（バージョンは1.99.0です）。

lambdaの動作テストのために関数内でイベントデータを扱いたいのですが（たとえば、S3のPUTイベントなど）、
AWSのsam local invokeコマンドの場合は、-eオプションでイベント用のjsonファイルが渡せますが、これと同様の
ことをsam local start-apiコマンドで行うにはどのようにすれば良いでしょうか。

invokeコマンドは単一関数のテストに使うコマンドだと理解しており、methodやパスの違いによる動作の検証はできない
のではないかと思いsam local start-apiコマンドを使っていますが、イベント用のjsonファイルを作成しても
渡し方がわかりません。
何か方法があればご教授いただきたいです。よろしくお願いいたします。

行動規範の内容に同意します

回答1件

ベストアンサー

結論から言うと、おそらくそれは不可能だと思うので実際にリクエストを送る方法を検討してみてください。

sam local invokeはLambdaにイベントをローカルで渡すためのコマンドです。
Lambdaには擬似的にイベントを渡してテストする機能があるので、それをローカル環境で行うためのものですね。

一方sam local start-apiはAPI Gateway+Lambdaの環境をローカルで擬似的に構築するものというイメージが近いかと思います。
API GatewayにはLambdaと違ってイベントを渡してテストするといった機能はなく、リクエストヘッダ、ボディ、クエリストリングを渡してテストをする機能があります。

sam local start-api を使用する

AWS Serverless Application Model コマンドラインインターフェイス (AWS SAM CLI) sam local start-api サブコマンドを使用して、AWS Lambda 関数をローカルで実行し、ローカル HTTP サーバーホストを通じてテストします。このタイプのテストは、Amazon API Gateway エンドポイントによって呼び出される Lambda 関数に役立ちます。

Lambdaはイベント駆動なので、イベントを受け取ってそれに対して動作を行うのに対して、API GatewayはAPIなので基本的にリクエストを受け取ってそれに対して動作をします。
start-apiでAPI Gatewayをローカルでエミュレートしているので、ローカルのAPIに対してリクエストを送れば、Lambdaに対してイベントを渡すのはAPI Gatewayがやってくれます。

つまり、冒頭の結論のようにsam local start-apiでエミュレートしたAPIに対してリクエストを送ってテストを行えばよい、ということになります。

投稿2023/10/27 05:17