チュートリアル: 2 つの AWS サービス統合と 1 つの Lambda 非プロキシ統合を使用して計算ツールの REST API を作成する

1. GET リソースで /calc メソッドを公開して Lambda 関数を呼び出し、入力をクエリ文字列パラメータとして渡します (AWS Service 統合)。

2. POST リソースで /calc メソッドを公開して Lambda 関数を呼び出すことにより、メソッドリクエストのペイロードに入力を提供します (AWS Service 統合)。

3. ネストされた GET リソースで /calc/{operand1}/{operand2}/{operator} を公開して Lambda 関数を呼び出し、パスパラメータとして入力を提供します (Lambda Function 統合)。

API Gateway の引き受け可能な IAM ロールを作成する

1. IAM コンソールにログインします。

2. [Roles (ロール)] を選択します。

3. [Create Role (ロールの作成)] を選択します。

4. [Select type of trusted entity] (信頼されたエンティティの種類を選択) の下で、[AWS Service] (AWS サービス) を選択します。

5. [このロールを使用するサービスを選択] の下で、[Lambda] を選択します。

6. [Next: Permissions (次へ: アクセス許可)] を選択します。

7. [ポリシーの作成] を選択します。

   新しい [ポリシーの作成] コンソールウィンドウが開きます。このウィンドウで、以下の操作を行います。

   1. [JSON] タブで、既存のポリシーを以下のポリシーに置き換えます。

      
      {
          "Version": "2012-10-17",
          "Statement": [
              {
                  "Effect": "Allow",
                  "Action": "lambda:InvokeFunction",
                  "Resource": "*"
              }
          ]
      }                        
              

   2. [ポリシーの確認] を選択します。

   3. [ポリシーの確認] で、以下の作業を行います。

      1. [名前] には lambda_execute などの名前を入力します。

      2. [ポリシーの作成] を選択します。

8. 元の [ロールの作成] ウィンドウで、以下の操作を行います。

   1. [アクセス権限ポリシーをアタッチする] で、ドロップダウンリストから lambda_execute ポリシーを選択します。

      ポリシーが一覧に表示されていない場合は、一覧の上部にある [refresh (更新)] ボタンをクリックしてください。(ブラウザページを更新しないでください)。

   2. [Next:Tags (次へ: タグ)] を選択します。

   3. 次: レビュー を選択します。

   4. [ロール名] には、lambda_invoke_function_assume_apigw_role などの名前を入力します。

   5. [ロールの作成] を選択します。

9. ロールのリストから lambda_invoke_function_assume_apigw_role 関数を選択します。

10. [信頼関係] タブを選択します。

11. [Edit trust relationship (信頼関係の編集)] を選択します。

12. 既存のポリシーを以下に置き換えます。

    
    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Sid": "",
          "Effect": "Allow",
          "Principal": {
            "Service": [
              "lambda.amazonaws.com",
              "apigateway.amazonaws.com"
            ]
          },
          "Action": "sts:AssumeRole"
        }
      ]
    }                        
            

13. [Update Trust Policy] を選択します。

14. 作成したロールのロール ARN を書き留めます。後で必要になります。

1. Lambda コンソールで、[Create function (関数の作成)] をクリックします。

2. [一から作成] を選択します。

3. [名前] に「Calc」と入力します。

4. [ランタイム] で、サポートされている最新の Node.js または Python ランタイムのいずれかを選択します。

5. 他のすべてのオプションについては、デフォルトの設定を使用します。

6. [Create function (関数の作成)] を選択します。

7. 任意のランタイムで以下の Lambda 関数をコピーし、Lambda コンソールのコードエディターに貼り付けます。

   Node.js

   export const handler = async function (event, context) {
     console.log("Received event:", JSON.stringify(event));
   
     if (
       event.a === undefined ||
       event.b === undefined ||
       event.op === undefined
     ) {
       return "400 Invalid Input";
     }
   
     const res = {};
     res.a = Number(event.a);
     res.b = Number(event.b);
     res.op = event.op;
     if (isNaN(event.a) || isNaN(event.b)) {
       return "400 Invalid Operand";
     }
     switch (event.op) {
       case "+":
       case "add":
         res.c = res.a + res.b;
         break;
       case "-":
       case "sub":
         res.c = res.a - res.b;
         break;
       case "*":
       case "mul":
         res.c = res.a * res.b;
         break;
       case "/":
       case "div":
         if (res.b == 0) {
           return "400 Divide by Zero";
         } else {
           res.c = res.a / res.b;
         }
         break;
       default:
         return "400 Invalid Operator";
     }
   
     return res;
   };

   Python

   import json
   
   
   def lambda_handler(event, context):
       print(event)
   
       try:
           (event['a']) and (event['b']) and (event['op'])
       except KeyError:
           return '400 Invalid Input'
   
       try:
           res = {
               "a": float(
                   event['a']), "b": float(
                   event['b']), "op": event['op']}
       except ValueError:
           return '400 Invalid Operand'
   
       if event['op'] == '+':
           res['c'] = res['a'] + res['b']
       elif event['op'] == '-':
           res['c'] = res['a'] - res['b']
       elif event['op'] == '*':
           res['c'] = res['a'] * res['b']
       elif event['op'] == '/':
           if res['b'] == 0:
               return '400 Divide by Zero'
           else:
               res['c'] = res['a'] / res['b']
       else:
           return '400 Invalid Operator'
   
       return res

8. 実行ロールで、[Choose an existing role (既存のロールを選択)] を選択します。

9. 前に作成した lambda_invoke_function_assume_apigw_role ロールのロール ARN を入力します。

10. [デプロイ] を選択します。

1. [テスト] タブを選択します。

2. テストイベントの名前として calc2plus5 と入力します。

3. テストイベントの定義を次のように置き換えます。

   {
     "a": "2",
     "b": "5",
     "op": "+"
   }

4. [保存] を選択します。

5. [Test (テスト)] を選択します。

6. [実行結果: 成功] を展開します。次のように表示されます。

   {
     "a": 2,
     "b": 5,
     "op": "+",
     "c": 7
   }

API を作成するには

1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

2. API Gateway を初めて使用する場合は、サービスの特徴を紹介するページが表示されます。[REST API] で、[構築] を選択します。[Create Example API (サンプル API の作成)] がポップアップ表示されたら、[OK] を選択します。

   API Gateway を使用するのが初めてではない場合、[Create API] (API を作成)を選択します。[REST API] で、[構築] を選択します。

3. [API 名] に「LambdaCalc」と入力します。

4. (オプション) [説明] に説明を入力します。

5. [API エンドポイントタイプ] を [リージョン別] に設定したままにします。

6. [Create API] を選択します。

/calc リソースを作成するには

1. [リソースの作成] を選択します。

2. [プロキシのリソース] はオフのままにします。

3. [リソースパス] は / のままにします。

4. [リソース名] に「calc」と入力します。

5. [CORS (Cross Origin Resource Sharing)] はオフのままにします。

6. [リソースの作成] を選択します。

GET メソッドを作成するには

1. /calc リソースを選択し、[メソッドを作成] を選択します。

2. [メソッドタイプ] には、GET を選択します。

3. [統合タイプ] で、[AWS のサービス] を選択します。

4. [AWS リージョン] で、Lambda 関数を作成した AWS リージョンを選択します。

5. [AWS のサービス] で、[Lambda] を選択します。

6. [AWS サブドメイン] は空白のままにします。

7. [HTTP メソッド] で、[POST] を選択します。

8. [アクションタイプ] で、[パスオーバーライドを使用] を選択します。このオプションでは、実行する Invoke アクションの ARN を指定して Calc 関数を呼び出すことができます。

9. [パスオーバーライド] に「2015-03-31/functions/arn:aws:lambda:us-east-2:account-id:function:Calc/invocations」と入力します。[ account-id] に AWS アカウント ID を入力します。[us-east-2] に、Lambda 関数を作成した AWS リージョンを入力します。

10. [実行ロール] に、lambda_invoke_function_assume_apigw_role のロール ARN を入力します。

11. [認証情報キャッシュ] と [デフォルトタイムアウト] の設定は変更しません。

12. [メソッドリクエストの設定] を選択します。

13. [リクエストの検証] で、[クエリ文字列パラメータおよびヘッダーを検証] を選択します。

    この設定により、クライアントが必要なパラメータを指定しなかった場合に、エラーメッセージが返されます。

14. [URL クエリ文字列パラメータ] を選択します。

    次に、[/calc] リソースで GET メソッドのクエリ文字列パラメータを設定し、バックエンドの Lambda 関数に代わって入力を受け取れるようにします。

    クエリ文字列パラメータを作成するには、次の操作を行います。

    1. [クエリ文字列の追加] を選択します。

    2. [名前] にoperand1と入力します。

    3. [必須] をオンにします。

    4. [キャッシュ] はオフのままにします。

    同じ手順を繰り返して、operand2 という名前のクエリ文字列と operator という名前のクエリ文字列を作成します。

15. [メソッドの作成] を選択します。

入力パラメータを統合リクエストにマッピングするには

1. [統合リクエスト] タブの [統合リクエストの設定] で、[編集] を選択します。

2. [リクエスト本文のパススルー] で、[テンプレートが定義されていない場合 (推奨)] を選択します。

3. [マッピングテンプレート] を選択します。

4. [マッピングテンプレートの追加] を選択します。

5. [コンテンツタイプ] に、「application/json」と入力します。

6. [テンプレート本文] に、次のコードを入力します。

   {
       "a":  "$input.params('operand1')",
       "b":  "$input.params('operand2')", 
       "op": "$input.params('operator')"   
   }

7. [Save] を選択します。

GET メソッドをテストするには

1. [テスト] タブを選択します。タブを表示するには、右矢印ボタンを選択する必要がある場合があります。

2. [クエリ文字列] に「operand1=2&operand2=3&operator=+」と入力します

3. [Test (テスト)] を選択します。

   結果は以下のようになります。

   

JSON ペイロードを持つ POST メソッドを作成するには

1. /calc リソースを選択し、[メソッドを作成] を選択します。

2. [メソッドタイプ] では、POST を選択します。

3. [統合タイプ] で、[AWS のサービス] を選択します。

4. [AWS リージョン] で、Lambda 関数を作成した AWS リージョンを選択します。

5. [AWS のサービス] で、[Lambda] を選択します。

6. [AWS サブドメイン] は空白のままにします。

7. [HTTP メソッド] で、[POST] を選択します。

8. [アクションタイプ] で、[パスオーバーライドを使用] を選択します。このオプションでは、実行する Invoke アクションの ARN を指定して Calc 関数を呼び出すことができます。

9. [パスオーバーライド] に「2015-03-31/functions/arn:aws:lambda:us-east-2:account-id:function:Calc/invocations」と入力します。[ account-id] に AWS アカウント ID を入力します。[us-east-2] に、Lambda 関数を作成した AWS リージョンを入力します。

10. [実行ロール] に、lambda_invoke_function_assume_apigw_role のロール ARN を入力します。

11. [認証情報キャッシュ] と [デフォルトタイムアウト] の設定は変更しません。

12. [メソッドの作成] を選択します。

入力モデルを作成するには

1. ナビゲーションペインで、[モデル] を選択します。

2. [モデルの作成] を選択します。

3. [名前] にinputと入力します。

4. [コンテンツタイプ] に、「application/json」と入力します。

   一致するコンテンツタイプが見つからない場合、リクエストの検証は実行されません。コンテンツタイプに関係なく同じモデルを使用するには、「$default」と入力します。

5. [モデルのスキーマ] に次のモデルを入力します。

   {
       "type":"object",
       "properties":{
           "a":{"type":"number"},
           "b":{"type":"number"},
           "op":{"type":"string"}
       },
       "title":"input"
   }

6. [モデルの作成] を選択します。

出力モデルを作成するには

1. [モデルの作成] を選択します。

2. [名前] にoutputと入力します。

3. [コンテンツタイプ] に、「application/json」と入力します。

   一致するコンテンツタイプが見つからない場合、リクエストの検証は実行されません。コンテンツタイプに関係なく同じモデルを使用するには、「$default」と入力します。

4. [モデルのスキーマ] に次のモデルを入力します。

   {
       "type":"object",
       "properties":{
           "c":{"type":"number"}
       },
       "title":"output"
   }

5. [モデルの作成] を選択します。

結果モデルを作成するには

1. [モデルの作成] を選択します。

2. [名前] にresultと入力します。

3. [コンテンツタイプ] に、「application/json」と入力します。

   一致するコンテンツタイプが見つからない場合、リクエストの検証は実行されません。コンテンツタイプに関係なく同じモデルを使用するには、「$default」と入力します。

4. [モデルスキーマ] に、restapi-id を使用して、次のモデルを入力します。restapi-id はコンソールの上部に、このフロー (API Gateway > APIs > LambdaCalc (abc123).) で括弧内に表示されます。

   {
       "type":"object",
       "properties":{
           "input":{
               "$ref":"https://apigateway.amazonaws.com/restapis/restapi-id/models/input"
           },
           "output":{
               "$ref":"https://apigateway.amazonaws.com/restapis/restapi-id/models/output"
           }
       },
       "title":"result"
   }

5. [モデルの作成] を選択します。

POST メソッドのリクエスト検証を有効にするには

1. メインナビゲーションペインで [リソース] を選択し、リソースツリーの POST メソッドを選択します。

2. [メソッドリクエスト] タブの [メソッドリクエスト設定] で、[編集] を選択します。

3. [リクエストの検証] で、[本文を検証] を選択します。

4. [リクエスト本文] を選択し、[モデルを追加] を選択します。

5. [コンテンツタイプ] に、「application/json」と入力します。

   一致するコンテンツタイプが見つからない場合、リクエストの検証は実行されません。コンテンツタイプに関係なく同じモデルを使用するには、「$default」と入力します。

6. [モデル] で [入力] を選択します。

7. [Save] を選択します。

POST メソッドをテストするには

1. [テスト] タブを選択します。タブを表示するには、右矢印ボタンを選択する必要がある場合があります。

2. [リクエスト本文] に次の JSON ペイロードを入力します。

   
   {
       "a": 1,
       "b": 2,
       "op": "+"
   }
                   

3. [テスト] を選択します。

   以下の出力が表示されます。

   
   {
     "a": 1,
     "b": 2,
     "op": "+",
     "c": 3
   }                    
                   

/{operand1}/{operand2}/{operator} リソースを作成するには

1. [リソースの作成] を選択します。

2. [リソースパス] で、/calc を選択します。

3. [リソース名] に「{operand1}」と入力します。

4. [CORS (Cross Origin Resource Sharing)] はオフのままにします。

5. [リソースの作成] を選択します。

6. [リソースパス] で、/calc/{operand1}/ を選択します。

7. [リソース名] に「{operand2}」と入力します。

8. [CORS (Cross Origin Resource Sharing)] はオフのままにします。

9. [リソースの作成] を選択します。

10. [リソースパス] で、/calc/{operand1}/{operand2}/ を選択します。

11. [リソース名] に「{operator}」と入力します。

12. [CORS (Cross Origin Resource Sharing)] はオフのままにします。

13. [リソースの作成] を選択します。

メソッド統合を設定するには

1. /{operand1}/{operand2}/{operator} を選択し、[メソッドを作成] を選択します。

2. [メソッドタイプ] には、GET を選択します。

3. [統合タイプ] で、[Lambda 関数] を選択します。

4. [Lambda プロキシ統合] はオフのままにしておきます。

5. [Lambda 関数] で、Lambda 関数を作成した AWS リージョンを選択し、「Calc」と入力します。

6. [デフォルトタイムアウト] はオンのままにします。

7. [メソッドの作成] を選択します。

マッピングテンプレートを作成するには

1. [統合リクエスト] タブの [統合リクエストの設定] で、[編集] を選択します。

2. [リクエスト本文のパススルー] で、[テンプレートが定義されていない場合 (推奨)] を選択します。

3. [マッピングテンプレート] を選択します。

4. [コンテンツタイプ] に、「application/json」と入力します。

5. [テンプレート本文] に、次のコードを入力します。

   {
      "a": "$input.params('operand1')",
      "b": "$input.params('operand2')",
      "op": #if($input.params('operator')=='%2F')"/"#{else}"$input.params('operator')"#end
   }

6. [Save] を選択します。

GET メソッドをテストするには

1. [テスト] タブを選択します。タブを表示するには、右矢印ボタンを選択する必要がある場合があります。

2. [パス] で、次の操作を行います。

   1. [operand1] に「1」と入力します。

   2. [operand2] に「1」と入力します。

   3. [operator] に「+」と入力します。

3. [Test (テスト)] を選択します。

4. 結果は以下のようになります。

   

メソッドレスポンスを作成するには

1. [メソッドレスポンス] タブの [レスポンス 200] で、[編集] を選択します。

2. [リクエスト本文] で、[モデルを追加] を選択します。

3. [コンテンツタイプ] に、「application/json」と入力します。

4. [モデル] で、[結果] を選択します。

5. [Save] を選択します。

マッピングテンプレートを作成するには

1. [統合レスポンス] タブの [デフォルト - レスポンス] で、[編集] を選択します。

2. [マッピングテンプレート] を選択します。

3. [コンテンツタイプ] に、「application/json」と入力します。

4. [テンプレート本文] に、次のコードを入力します。

   #set($inputRoot = $input.path('$'))
   {
     "input" : {
       "a" : $inputRoot.a,
       "b" : $inputRoot.b,
       "op" : "$inputRoot.op"
     },
     "output" : {
       "c" : $inputRoot.c
     }
   }

5. [Save] を選択します。

マッピングテンプレートをテストするには

1. [テスト] タブを選択します。タブを表示するには、右矢印ボタンを選択する必要がある場合があります。

2. [パス] で、次の操作を行います。

   1. [operand1] に「1」と入力します。

   2. [operand2] に「2」と入力します。

   3. [operator] に「+」と入力します。

3. [テスト] を選択します。

4. 結果は次のようになります。

   {
     "input": {
       "a": 1,
       "b": 2,
       "op": "+"
     },
     "output": {
       "c": 3
     }
   }

API をデプロイする

1. [API のデプロイ] を選択します。

2. [ステージ] で [新規ステージ] を選択します。

3. [Stage name (ステージ名)] に Prod と入力します。

4. (オプション) [説明] に説明を入力します。

5. [デプロイ] を選択します。

6. (オプション) [ステージの詳細] の [呼び出し URL] で、コピーアイコンを選択して API の呼び出し URL をコピーします。Postman や cURL のようなツールでこれを使用して API をテストできます。