はじめに
前回Lambdaを使ってみたので
つぎはAPI Gateway との連携できたらいいよね!と思ってチュートリアルやってみようとしたら
初心者すぎていろんなことに引っかかったという記事です。
丁寧な公式チュートリアルはこちら
Lambda関数はどうしてもpythonで書きたかったので
公式チュートリアルからはちょっと外れてそこの処理だけpythonで書くこととします。
最初に手順を一通りなぞった後に、私が引っかかったポイントについてまとめていこうと思います。
公式のステップに則った手順
ステップ 1: Lambda 関数を作成する
-
Lambdaのページに行き、「関数の作成」ボタンを押す
-
「一から作成」を選択。「関数名」に適当な名前を入力。ランタイムに「python3.9」を選択。
その他はそのままで「関数の作成」をする
-
以下ページを参考*にLambda関数を書く
HTTP API の AWS Lambda プロキシ統合の使用
*ここに引っかかりポイントあったので注意です
このようにしました。
import json
def lambda_handler(event, context):
# TODO implement
return {
"isBase64Encoded": False,
"statusCode": 200,
"body": "{ \"message\": \"Hello from Lambda!\" }",
"headers": {"content-type": "application/json"}
}
ステップ 2: HTTP API を作成する
- API Gateway コンソールにサインインして「APIを構築」を押す
- 「API タイプを選択」で「HTTP API」の「構築」を押す
- 「統合を作成して設定」で「統合を追加」を押す
- プルダウンから「lambda」を選択、
リージョンが目的のリージョンになっているか確認して、テキストボックスでlambda関数を検索 - 目的の関数が選択できたら「API名」に適当な名前を入力し「次へ」を押す
- 「ルートを設定」を確認して(何もせずに)「次へ」を押す
- 「ステージを設定 」を確認して(何もせずに)「次へ」を押す
- 「確認して作成」の一番下「作成」ボタンを押す
ステップ 3: API をテストする
- API Gateway コンソールにサインインする
- 作成したAPI を選択
- API の呼び出し URL をコピー
- ブラウザのアドレスバーにペースト
- 後ろに「/作ったlambdaの関数名」をつけて検索
(今回は「test_lambda_python」という名前にしたのでアドレスバーには「https://~~~amazon.com/test_lambda_python」と入力) - ページに「{ "message": "Hello from Lambda!" }」と表示されればOK!
引っかかりポイント
その①:Lambdaの中身、pythonで書きたい!
チュートリアル、Lambdaの中身がNode.jsで書かれてたんですね。
しかしながら使いたいのはpython!ということで関数の中身をどう書いていけばいいのか調べました。
参考になったのは以下ページです。
ここで注意すべきだったのが最初のAWS公式ページの「Lambda 関数レスポンス形式 2.0」を
そのままコピペするとエラー出るってところです。
以下が参考に書かれているjsonファイルそのままコピペしたものです。
{
"isBase64Encoded": false,
"statusCode": 200,
"body": "{ \"message\": \"Hello from Lambda!\" }",
"headers": {
"content-type": "application/json"
}
}
よく見ると、falseのfが小文字なんですね!!!
pythonはfalseではなくFalseと書かないといけないので、これそのままだとエラーが出ます。
おかげさまでデバッグの仕方も学べました(後述)
その②:APIの種類がいくつもあるやんけ!
ステップ2でAPI Gatewayのページにアクセスしてみて
API、3つも種類あるじゃん。。今後どれ使えばええの。。。となる方は私だけじゃないはず。
気になって前に進めなかったのでとりあえずAWS公式のものを読んでみる
わからない部分も多かったので以下なども参照
Websocketと、REST・HTTPは働きが違いそうということ
HTTPはRESTの簡単版でかつ新しいものetcだということをざっくり理解しました。
その③:そうなってくるとREST APIも使ってみたくない??
と、なったので、REST APIも使ってみました。
チュートリアルがあったので、これのAPIの構築部分を参考に進めてみます。
チュートリアル: Lambda プロキシ統合を使用した Hello World REST API の構築
-
API Gateway コンソールにサインイン
-
「APIを作成」→REST APIの「構築」を押す
-
「プロトコルの選択」「新しいAPIの作成」はデフォルトのままで
「API名」に適当な名前を入力し
「エンドポイントタイプ」が「リージョン」になっていることを確認して「APIの作成」を押す
-
「プロキシリソースとして設定」 チェックボックスはオフのまま、
「リソース名」に適当な名前を入力(今回は「test」)
「リソースパス」はいじらずそのまま (今回は/test)
「API Gateway CORS を有効にする」チェックボックスはオフのまま
「リソースの作成」を押す
-
「統合タイプ」を「Lambda関数」
「Lambdaプロキシ統合の使用」にチェック
リージョンを目的のリージョンに合わせて
作ってたLambda関数をテキストボックスで検索(今回は「test_lambda_python」)
「デフォルトタイムアウトの使用」チェックボックスをオンのままにして「保存」を押す
-
「Lambda 関数に権限を追加する」のポップアップが出てくるので「OK」を押す
-
「APIのデプロイ」ポップアップが出てくるので
「デプロイされるステージ」に「新しいステージ」を選択
「ステージ名」に適当な名前を入力(今回は「test」とした)して「デプロイ」を押す
-
アドレスバーにコピーしたURLを張り付け、最後に「/リソース名(今回は「test」、ステージ名と一緒にしたらわかりづらくなった)」を追加し検索。(https://~~~amazonaws.com/test/testとなる)
これでREST APIの設定はOKです。
その④:デバッグの仕方
Falseをfalseのまま実行すると、「{"message":"Internal Server Error"}」というメッセージが表示されます。
調べてみると公式に問題そのもののデバッグの仕方が書いてありました。
HTTP API Lambda 統合に関する問題のトラブルシューティング
これはもうこのまんまの手順に則って、CloudWatchの設定してログを見てみたら一発解決しました。
"false"が定義されていないよ、的なエラーメッセージが出てました。
ありがとうわかりやすい解説!
おわりに
苦戦しつつもAPI Gateway⇔Lambdaを試すことができました。
引っかかった分だけ勉強になってると信じて、引き続き手を動かしていけたらと思います。