チュートリアル: Lambda と DynamoDB を使用した CRUD API の構築 - Amazon API Gateway

チュートリアル: Lambda と DynamoDB を使用した CRUD API の構築

このチュートリアルでは、DynamoDB テーブルから項目を作成、読み取り、更新、削除するサーバーレス API を作成します。DynamoDB は、高速で予測可能なパフォーマンスとシームレスな拡張性を特長とするフルマネージド NoSQL データベースサービスです。このチュートリアルの所要時間は約 30 分で、AWS の無料利用枠内で実行できます。

まず、DynamoDB コンソールを使用して DynamoDB テーブルを作成します。次に、AWS Lambda コンソールを使用して Lambda 関数を作成します。次に、API Gateway コンソールを使用して HTTP API を作成します。最後に、API をテストします。

HTTP API を呼び出すと、API Gateway はリクエストを Lambda 関数にルーティングします。Lambda 関数は DynamoDB と対話し、API ゲートウェイにレスポンスを返します。それから API Gateway はレスポンスを返します。


      このチュートリアルで作成する API のアーキテクチャの概要。クライアントは、API Gateway HTTP API を使用して Lambda 関数を呼び出します。Lambda 関数は DynamoDB と対話し、クライアントにレスポンスを返します。

このエクササイズを完了するには、AWS アカウントと、コンソールへのアクセス権がある AWS Identity and Access Management ユーザーが必要です。詳細については、「API Gateway の開始方法の前提条件」を参照してください。

このチュートリアルでは、 を使用しますAWS Management Console この API とすべての関連リソースを作成する AWS SAM テンプレートについては、template.yaml を参照してください。

ステップ 1: DynamoDB テーブルを作成する

DynamoDB テーブルを使用して API のデータを保存します。

各項目には一意の ID があり、これをテーブルのパーティションキーとして使用します。

DynamoDB テーブルを作成するには

  1. https://console.aws.amazon.com/dynamodb/ で DynamoDB コンソールを開きます。

  2. [Create table] を選択します。

  3. [テーブル名] に「http-crud-tutorial-items」と入力します。

  4. [プライマリキー] に「id」と入力します。

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

ステップ 2: Lambda 関数を作成する

API のバックエンドに Lambda 関数を作成します。この Lambda 関数は、DynamoDB から項目を作成、読み取り、更新、および削除します。この関数は、API ゲートウェイのイベントを使用して DynamoDB との対話方法を決定します。わかりやすくするために、このチュートリアルでは 1 つの Lambda 関数を使用しますが、ルートごとに個別の関数を作成するのがベストプラクティスです。

Lambda 関数を作成するには

  1. Lambda コンソール (https://console.aws.amazon.com/lambda/) にサインインします。

  2. [関数の作成] を選択します。

  3. [関数名] に「http-crud-tutorial-function」と入力します。

  4. [アクセス許可] で [デフォルトの実行ロールの変更] を選択します。

  5. [Create a new role from AWS policy templates] (AWS のポリシーテンプレートから新しいロールを作成) を選択します。

  6. [ロール名] に「http-crud-tutorial-role」と入力します。

  7. [ポリシーテンプレート] では、[Simple microservice permissions] を選択します。このポリシーは、Lambda 関数に DynamoDB と対話するためのアクセス許可を付与します。

    注記

    このチュートリアルでは、わかりやすくするために管理ポリシーを使用しますが、独自の IAM ポリシーを作成して、必要な最小限のアクセス許可を付与するのがベストプラクティスです。

  8. [関数の作成] を選択します。

  9. コンソールのコードエディタで index.js を開き、その内容を次のコードに置き換えます。[デプロイ] を選択して、関数を更新します。

const AWS = require("aws-sdk"); const dynamo = new AWS.DynamoDB.DocumentClient(); exports.handler = async (event, context) => { let body; let statusCode = 200; const headers = { "Content-Type": "application/json" }; try { switch (event.routeKey) { case "DELETE /items/{id}": await dynamo .delete({ TableName: "http-crud-tutorial-items", Key: { id: event.pathParameters.id } }) .promise(); body = `Deleted item ${event.pathParameters.id}`; break; case "GET /items/{id}": body = await dynamo .get({ TableName: "http-crud-tutorial-items", Key: { id: event.pathParameters.id } }) .promise(); break; case "GET /items": body = await dynamo.scan({ TableName: "http-crud-tutorial-items" }).promise(); break; case "PUT /items": let requestJSON = JSON.parse(event.body); await dynamo .put({ TableName: "http-crud-tutorial-items", Item: { id: requestJSON.id, price: requestJSON.price, name: requestJSON.name } }) .promise(); body = `Put item ${requestJSON.id}`; break; default: throw new Error(`Unsupported route: "${event.routeKey}"`); } } catch (err) { statusCode = 400; body = err.message; } finally { body = JSON.stringify(body); } return { statusCode, body, headers }; };

ステップ 3: HTTP API を作成する

HTTP API は、Lambda 関数の HTTP エンドポイントを提供します。このステップでは、空の API を作成します。次のステップでは、API と Lambda 関数を接続するようにルートと統合を設定します。

HTTP API を作成するには

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

  2. [API を作成] を選択し、[HTTP API] で [構築] を選択します。

  3. [API 名] に「http-crud-tutorial-api」と入力します。

  4. [Next (次へ)] を選択します。

  5. [ルートの設定] で、[次へ] を選択してルートの作成をスキップします。ルートは後で作成します。

  6. API Gateway によって作成されるステージを確認し、[次へ] をクリックします。

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

ステップ 4: ルートを作成する

ルートは、着信 API リクエストをバックエンドリソースに送信する方法です。ルートは、HTTP メソッドとリソースパスという 2 つの部分で構成されます (例: GET /items)。この例の API では、次の 4 つのルートを作成します。

  • GET /items/{id}

  • GET /items

  • PUT /items

  • DELETE /items/{id}

ルートを作成するには

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

  2. API を選択します。

  3. [ルート] をクリックします。

  4. [Create] を選択します。

  5. [Method] (メソッド) で、[GET] を選択します。

  6. パスには、「/items/{id}」と入力します。パスの末尾にある {id} は、クライアントがリクエストを行うときに API Gateway がリクエストパスから取得するパスパラメータです。

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

  8. GET /itemsDELETE /items/{id}、および PUT /items について、ステップ 4~7 を繰り返します 。


        API には GET /items、GET /items/{id}、DELETE
            /items/{id}、および PUT /items 用のルートがあります。

ステップ 5: 統合を作成する

ルートをバックエンドリソースに接続するための統合を作成します。この API の例では、すべてのルートに使用する 1 つの Lambda 統合を作成します。

統合を作成するには

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

  2. API を選択します。

  3. [統合] を選択します。

  4. [統合を管理] を選択し、[作成] をクリックします。

  5. [この統合をルートにアタッチする] はスキップします。これは、後の手順で完了します。

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

  7. [Lambda 関数] に「http-crud-tutorial-function」と入力します。

  8. [Create] を選択します。

ステップ 6: 統合をルートにアタッチする

この API の例では、すべてのルートで同じ Lambda 統合を使用します。統合を API のすべてのルートにアタッチすると、クライアントがいずれかのルートを呼び出すと Lambda 関数が呼び出されます。

統合をルートにアタッチするには

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

  2. API を選択します。

  3. [統合] を選択します。

  4. ルートを選択します。

  5. [既存の統合を選択する] で、[http-crud-tutorial-function] を選択します。

  6. [統合をアタッチする] を選択します。

  7. すべてのルートについて、ステップ 4~6 を繰り返します。

すべてのルートが、AWS Lambda 統合がアタッチされていることを示します。


        コンソールでは、すべてのルートに AWS Lambda が表示され、統合がアタッチされていることを示します。

ルートと統合を持つ HTTP API ができたので、API をテストできます。

ステップ 7: API をテストする

API が動作していることを確認するには、curl を使用します。

API を呼び出すための URL を取得するには

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

  2. API を選択します。

  3. API の呼び出し URL を書き留めます。URL は、[詳細] ページの [URL を呼び出す] の下に表示されます。

    
            APIを作成すると、コンソールに API の呼び出し URL が表示されます。
  4. API の呼び出し URL をコピーします。

    完全な URL は https://abcdef123.execute-api.us-west-2.amazonaws.com のように見えます。

項目の作成または更新

  • 次のコマンドを使用して、項目を作成または更新します。コマンドには、項目の ID、料金、名前を含むリクエスト本文が含まれます。

    curl -v -X "PUT" -H "Content-Type: application/json" -d "{\"id\": \"abcdef234\", \"price\": 12345, \"name\": \"myitem\"}" https://abcdef123.execute-api.us-west-2.amazonaws.com/items

すべての項目を取得するには

  • すべての項目を一覧表示するには、次のコマンドを使用します。

    curl -v https://abcdef123.execute-api.us-west-2.amazonaws.com/items

1 つの項目を取得するには

  • ID で 1 つの項目を取得するには、次のコマンドを使用します。

    curl -v https://abcdef123.execute-api.us-west-2.amazonaws.com/items/abcdef234

項目を削除するには

  1. 項目を削除するには、次のコマンドを使用します。

    curl -v -X "DELETE" https://abcdef123.execute-api.us-west-2.amazonaws.com/items/abcdef234
  2. 項目が削除されたことを確認するには、すべての項目を取得します。

    curl -v https://abcdef123.execute-api.us-west-2.amazonaws.com/items

ステップ 8: クリーンアップする

不要なコストを回避するには、このエクササイズで作成したリソースを削除します。次の手順では、HTTP API、Lambda 関数、および関連リソースを削除します。

DynamoDB テーブルを削除するには

  1. https://console.aws.amazon.com/dynamodb/ で DynamoDB コンソールを開きます。

  2. テーブルを選択します。

  3. [テーブルの削除] を選択します。

  4. 選択を確認して、[削除] をクリックします。

HTTP API を削除するには

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

  2. [ API ] ページで、API を選択します。[ Actions] を選択して、[Delete] を選択します。

  3. [削除] を選択します。

Lambda 関数を削除するには

  1. Lambda コンソール (https://console.aws.amazon.com/lambda/) にサインインします。

  2. [ 関数 ] ページで、関数を選択します。[ Actions] を選択して、[Delete] を選択します。

  3. [削除] を選択します。

Lambda 関数のロググループを削除するには

  1. Amazon CloudWatch コンソールで、[ ロググループページ]を開きます。

  2. [ロググループ] ページで、関数のロググループ (/aws/lambda/http-crud-tutorial-function) を選択します。[Actions] (アクション) を選択してから、[Delete log group] (ロググループの削除) を選択します。

  3. [削除] を選択します。

Lambda 関数の実行ロールを削除するには

  1. AWS Identity and Access Management コンソールの [Roles] (ロール) ページを開きます。

  2. 関数のロールを選択します (例: http-crud-tutorial-role)。

  3. [ロールの削除] を選択します。

  4. [はい、削除します] を選択します。

次のステップ: AWS SAM または AWS CloudFormation を使用して自動化する

AWS CloudFormation または AWS SAM を使用して、AWS リソースの作成とクリーンアップを自動化できます。このチュートリアルのサンプル AWS SAM テンプレートについては、template.yaml を参照してください。

AWS CloudFormation テンプレートの例については、「サンプル AWS CloudFormation テンプレート」を参照してください。