.NET を使用した Amazon API ゲートウェイ

この包括的な記事では、.NET スタックを使用した Amazon API Gateway について学習します。これを使用すると、AWS Lambda を非常に簡単に外部の世界に公開できます。

以前の記事で、.NET を使用して AWS Lambda を操作する方法について学びました。これは、サーバーレス アプリケーションを開始するための重要なポイントです。これらの Lambda を AWS に構築してデプロイしましたが、それらを外部の世界から呼び出されるように公開する方法について実際に話したことはありませんでした。

この包括的なガイドではさらに、Amazon API Gateway、Lambda、DynamoDb for Persistence、およびロギング目的の Cloudwatch をシームレスに統合する完全なサーバーレス アプリケーションを構築します。

実装のソース コードはここにあります。

Amazon API ゲートウェイとは?

Amazon API Gateway は、基本的にアプリケーションのビジネス ロジックの世界への扉として機能するゲートウェイを作成できる完全マネージド型のサービスです。このサービスでは、基本的に、Amazon API Gateway の構築方法に応じて、アクセス時に AWS Lambda、パブリック エンドポイント、およびその他のさまざまな AWS サービスに接続するエンドポイントを公開します。

インターネット上で実行されているアプリケーションが、ラムダ内にあるビジネス ロジックにアクセスする必要があるとします。これらのクライアント アプリケーションは Amazon API Gateway に接続し、Amazon API Gateway は関連する AWS Lambda または構成済みの他のサービスにリクエストを内部的にリダイレクトします。

API ゲートウェイを介した一般的なリクエスト フローがどのようなものかを図で見てみましょう。

.NET を使用した Amazon API ゲートウェイ

ご覧のとおり、クライアントは内部でサービスに接続されているゲートウェイにアクセスします。例えば、

  • www.<url-of-aws-gateway>/test -> は、test-lambda という名前のラムダにリダイレクトします
  • www.<url-of-aws-gateway>/get-students -> は、学生のリストを返すラムダにリダイレクトします
  • www.<url-of-aws-gateway>/weather?city=trivandrum -> は、Trivandrum 市の気象データを返すパブリック気象 API エンドポイントにリダイレクトします。

現在、API ゲートウェイは、AWS サーバーレス エコシステム全体の重要な部分であることが多く、あらゆる規模で AWS のサービスに非常にクールで簡単にアクセスできるようになっています。

AWS REST API と HTTP API の比較

AWS は、API Gateway サービスの 2 つのバージョンをサポートしています。最初のリリースは、API ゲートウェイを設計、開発、および維持するための多数の機能を含む REST API バリアント用でした。その後、2019 年頃、AWS はゲートウェイの作成とデプロイを簡素化する HTTP API を導入しました。命名を混同しないでください。これらのバージョンは両方とも、REST 規則に従って HTTP プロトコルに基づいて構築されています。内部的には、AWS はそれらを v1 (REST API) および v2 (HTTP API) と名付けています。

これらのバージョンには、パフォーマンス、価格設定、開発経験など、多くの重要な違いがあります。要するに、HTTP Api はほぼすべての部門で優れており、ほとんどの場合に選択する必要があります。

  • まず、HTTP API はパフォーマンスが向上することを意図しており、REST API と比較してパフォーマンスがほぼ 10 ~ 15% 向上しています。
  • 料金に関しては、月あたり最初の 3 億回のリクエストに対して、HTTP API の費用はわずか 1 米ドルですが、同じ量の場合、REST API の費用は約 3.5 米ドルです。これは大きな違いです。AWS 無料利用枠には、最初の 12 か月間は月あたり 100 万の API (REST & HTTP) が完全に無料で含まれていることに注意してください。これらのクールな技術の両方を探索するのに十分な時間ですよね?
  • これらのゲートウェイの開発中に AWS コンソールによって提供されるユーザー エクスペリエンスは、互いにまったく異なります。
  • REST API は、エンドポイントが世界中に高度に分散されていることを保証するエッジ最適化エンドポイントをサポートしていますが、HTTP エンドポイントは地域展開のみをサポートしているため、応答がわずかに遅れる可能性があります。
  • これらはどちらも本質的に非常に安全です。
  • カナリア デプロイは REST API に含まれていますが、これがデプロイ戦略にとって大きな問題である場合は、HTTP API には含まれていません。

詳細な比較については、これらの両方のバージョンを比較するAWS の開発者ガイドを参照してください。HTTP API は REST よりも安価ですが、REST API には価格差を正当化する非常に多くの機能が含まれていることは確かです。

デモンストレーションでは、HTTP API を使用します。おそらく後の記事で、REST API について説明します。コンセプト的には、どちらもほぼ同じです。Lambda に関する以前の記事で行ったように、Visual Studio 2022 Community を AWS SDK Kit 拡張機能と共に使用して、Lambda を開発、テスト、モックし、AWS クラウドに公開します。

.NET 上の AWS Lambda に関する以前の記事を既に読んでいることが重要です。この記事では、CLI を介して AWS 認証情報をセットアップし、Visual Studio Code に AWS ツールキットをインストールしました。そうでない場合は、このブログ投稿を参照してください。

.NET を使用した AWS Lambda の構築と公開

まず、Visual Studio 2022 を開いて空のソリューションを作成しましょう。ソリューションにAWSServerless.Dotnet.Demoという名前を付けました。基本的に、これには 2 つの Lambda プロジェクトがあり、徐々に追加します。

  1. Hello メッセージを返すダミーの Lambda。このラムダは、Amazon API Gateway 統合の基本などを紹介するために使用されます。
  2. DynamoDB に対していくつかの基本的な CRUD 操作を実行できる複数の関数ハンドラーを追加する Student Lambda。(追伸、.NET を使用して DynamoDB を開始する方法についての記事を書きました。それもチェックしてください。)

続行する前に、次のものがすでに整っていることを確認してください。

  • AWS CLI を介した AWS 認証情報のセットアップ。
  • Visual Studio インストールにインストールされた AWS Toolkit。
  • AWS アカウントを持っている。無料利用枠で十分です。

上記の手順に関連する詳細については、.NET を使用した AWS サーバーレス アプリケーションに関する以前の記事を参照してください。

空のプロジェクトを作成する aws serverless Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

最初の Lambda プロジェクトを空のソリューションに追加しましょう。Visual Studio でソリューションを右クリックし、[新しいプロジェクトの追加] をクリックします。Visual Studio インスタンスに AWS Toolkit が既にインストールされていると仮定すると、表示される [新しいプロジェクトの追加] ポップアップで AWS Lambda を検索できます。

devenv iArkd7DjVv Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

[次へ] をクリックします。ここで、ラムダに HelloLambda という名前を付けましょう。前述のように、これは単純なラムダであり、Amazon API Gateway と .NET との統合全体がどのようになるかを理解するのに役立ちます。新しいラムダの設計図を選択するように求められたら、「空の関数」を選択します。これにより、単純な Lambda の構築を開始するための白紙の状態が得られます。

AWS Lambda プロジェクトのフォルダー構造については、すでによくご存じでしょう。そうでない場合は、この記事を読んでください。Function.cs / FunctionHandler を開きます。この Handler を API Gateway にアタッチするため、このメソッドの署名にいくつかの小さな変更を加える必要があります。しかしその前に、コントラクトを含むこの Lambda プロジェクトにパッケージをインストールしましょう。パッケージ マネージャー コンソールを開き、次のコマンドを実行してパッケージをインストールします。

Install-Package Amazon.Lambda.APIGatewayEvents

それでは、FunctionHandler を変更してみましょう。

public APIGatewayHttpApiV2ProxyResponse FunctionHandler(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
request.QueryStringParameters.TryGetValue("name", out var name);
name = name ?? "John Doe";
var message = $"Hello {name}, from AWS Lambda";
return new APIGatewayHttpApiV2ProxyResponse
{
Body = message,
StatusCode = 200
};
}

APIGatewayHttpApiV2ProxyRequest は、HTTP API からの着信要求を表します。考えてみると、または最初のフロー図を振り返ると、Lambda が受け取るリクエストはクライアントから直接ではなく、Amazon API Gateway 自体からのリクエストです。したがって、この場合、API Gateway はAPIGatewayHttpApiV2ProxyRequestタイプのリクエストを Lambda に送信します。同様に、APIGatewayHttpApiV2ProxyResponseは、Lambda が Amazon API Gateway に返すレスポンスのタイプです。この応答部分をスキップして、学生のリストなどの重要なデータをビジネス要件として返すこともできます。これは、このガイドでさらに次の Lambda を構築するときに行います。

これらは、API Gateway 統合全体をサポートするための Lambda の主要な変更でした。それとは別に、関数ハンドラーは「Hello {name}, from AWS Lambda」というメッセージを返すようになりました。ここでのもう 1 つのことは、Lambda 内から、クエリ文字列、パス パラメータ、ルートなどを含む受信コンテキストにアクセスできることです。この Lambda の場合、受信リクエストには名前 (…/hello?name=Mukesh) のクエリ パラメータが含まれ、最終的に返されるメッセージに追加されると予想されます。

クエリ パラメータが存在しない場合は、既定の名前である John Doe が使用されます。応答をタイプAPIGatewayHttpApiV2ProxyResponseとして返すことに注意してください。ここで、Body は実際のメッセージであり、ステータス コード 200 SUCCESS を提供します。

最初の Lambda は以上です。それを AWS に発行して、Visual Studio 内でローカルにモック テストを行いましょう。HelloLambda プロジェクトを右クリックし、[AWS Lambda に発行] をクリックします。次のポップアップが表示されます。

image .NET を使用した Amazon API Gateway - AWS Lambda と DynamoDB の統合

最初のいくつかの詳細は、ローカルの AWS 認証情報、リージョン、およびプロファイルを設定していれば、ツールによって自動的に入力されます。

  • 関数名は、AWS アカウントで Lambda を識別するための名前です。
  • 説明 - 名前が示すように。
  • ハンドラーはここでちょっと重要です。Function.cs が複数の Handler メソッドを持つ可能性があるとします。この Handler メソッドは、Lambda が指す必要がある正確な関数にマップされます。この場合、HelloLambda::HelloLambda.Function::FunctionHandler です。記事の後半でこのフィールドを使用するため、これを覚えておいてください。

[次へ] をクリックします。

devenv oEzQI2HY6h Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

次の画面で必要な変更は、必要な正しい役割を選択することだけです。この場合、AWSLambdaBasicExecutionRole です。これには、ログを AWS Cloudwatch に書き込むためのアクセス許可が付属しています。それでおしまい。[アップロード] をクリックします。AWS は必要なロールの作成を開始し、いくつかのコマンドを実行して Lambda をローカルで構築およびリリースし、公開されたライブラリを圧縮して AWS にアップロードし、最終的に新しい光沢のある Lambda を作成します。

.NET を使用した Amazon API Gateway - AWS Lambda と DynamoDB の統合

完了したら、AWS マネジメント コンソールを開き、Lambdas に移動して、新しい Lambda が作成されたことを確認します。

画像 2 .NET を使用した Amazon API Gateway - AWS Lambda と DynamoDB の統合

Visual Studio に戻ると、パブリッシュ ウィザードが、Visual Studio から直接 Lambda をテストするのに役立つ小さなツールを開いたことがわかります。ああ、まだ気付いていない場合は、Lambda アプリケーションをデバッグ モードで実行することもできます。Visual Studio は、基本的に Lambda コードのテストとデバッグに役立つモック ツールを起動します。

ここでは、Visual Studio インターフェイスに組み込まれているツールについて調べてみましょう。以下はスクリーンショットです。

画像 1 .NET を使用した Amazon API Gateway - AWS Lambda と DynamoDB の統合

まず、このインターフェイスを使用すると、AWS にデプロイされた Lambda にモック リクエストを直接送信できます。Example Request ドロップダウンをクリックし、API Gateway AWS Proxy を選択します。このツールは、サンプル リクエストに対応します。ここでは、私が行ったように、名前のキー/値をクエリ文字列パラメーターに追加できます。ここにはいじるプロパティがたくさんあります。[Invoke] をクリックすると、応答にステータス コード 200 のメッセージが含まれます。

これで Lambda の準備が整いましたが、VS デバッグ ツール以外にこの関数にアクセスする方法はありません。そのため、リクエストを送信するリンク/エンドポイントが必要であり、Lambda から同様のリクエストが返されることを期待しています。これが、Amazon API Gateway の出番です。

.NET を使用した Amazon API Gateway の作成

最初の Amazon API Gateway の設計を始めましょう。AWS マネジメント コンソールに表示される検索バーで API Gateway を検索します。Amazon API Gateway のデフォルトのランディング ページが表示されます。ここで、API タイプを選択するための選択肢が表示されます。HTTP API を使用するので、それに関連付けられている Build ボタンをクリックしましょう。

chrome HZudzLTStT Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

Lambda が正常に作成されたので、統合タイプを Lambda として選択し、hello Lambda 関数を選択できます。バージョン 2.0 のペイロードが最新であることを確認してください。また、適切な AWS リージョンを選択してください。私の場合は ap-south-1 です。それが完了したら、[次へ] をクリックします。

chrome ZaswQgDPsT Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

次は興味深い部分です。hello Lambda を呼び出すことができる実際のルートを設定します。/hello のエンドポイントを持ち、Hello Lambda をターゲットとする GET メソッドにしたことがわかります。基本的に、API ゲートウェイを作成すると、AWS はエンドポイント URL を提供します。これに /hello を追加し、適切なクエリ パラメータを指定して GET メソッドを送信すると、Lambda がトリガーされ、目的の応答が返されます。

ここでは、複数のルートと統合が可能であることに注意してください。これについては、この記事の後半で本格的な API ゲートウェイを作成するときに調べます。

chrome 1j5EYx3xWe Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

次に、ウィザードはステージを作成するように求めます。これは、Amazon API Gateway を開発、本番、ステージングなどのさまざまな段階にデプロイする場合に便利です。しかし、ここでは、デフォルト値の $default のままにして、[次へ] をクリックします。

ここで変更を確認し、ゲートウェイをデプロイできます。それだけです、それと同じくらい簡単です。

以下の画面では、先ほど作成した Amazon API Gateway の URL を確認できます。これをコピーして、Postman または使用する API テスト ツールを開きます。また、これは単なる GET メソッドであるため、ブラウザを使用してゲートウェイをテストすることもできます。

chrome kmkvkIZHmM Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

API ゲートウェイがどのように応答するかをテストしてみましょう。テストには Postman を使用します。GET メソッドであることを確認してください。そうしないと、ゲートウェイはそのようなエンドポイントが見つからないと叫びます。

以下のスクリーンショットでは、リクエストを /hello エンドポイントに送信し、クエリ パラメータ名を自分の名前として渡したことがわかります。また、Lambda からの予期される応答も確認できます。とても簡単ですよね?詳細については、Hello Lambda を自由にいじってみてください。

Postman 09XFb6JnKd Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

Amazon API Gateway コンソール インターフェイスの探索

.NET を利用した AWS Lambda を使用して最初の Amazon API Gateway を作成したので、Amazon API Gateway で提供されるインターフェイスと機能を調べてみましょう。

ホームページには、特定の AWS リージョンで作成したゲートウェイのリストが表示されます。

chrome RYg52eeVpW Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

特定の API ゲートウェイに入ると、ゲートウェイを微調整するための一連の優れた機能にアクセスできます。

chrome C3lh3VJBk3 Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

ここから、次のようになります。

  • 既存の Amazon API Gateway にさらにルートを追加します。
  • Lambda と JWT を使用して Amazon API Gateway を保護します。これについては、次の記事で詳しく説明します。
  • 統合とラムダを管理します。
  • CORS ポリシーを構成します。
  • OpenAPI 定義のエクスポート/インポート。
  • 必要に応じてアクセスログを書き込みます。そのため、API ゲートウェイ経由でリクエストが送信されるたびに、そのリクエストは Cloudwatch にログインされます。これには、ログ グループの宛先を指定する必要があります。これについては、記事の後半で説明します。
  • ステージの管理・作成など。

.NET を使用した Amazon API Gateway がどのように機能するかについての基本的な理解が得られたので、AWS Lambda、複数の関数ハンドラー、Cloudwatch、DynamoDB を使用してデータを保存し、最終的にすべてを統合する、より高度なサーバーレス アプリケーションを構築しましょう。これらの Lambda は Amazon API Gateway を使用します。

.NET を使用した学生管理 AWS Lambda の構築

すべての学生の詳細を取得し、ID で学生を取得し、新しい学生レコードを作成できるシンプルな API を構築します。新しい Lambda プロジェクトをソリューションに追加し、StudentLambda という名前を付けます。はい、1 つの Lambda プロジェクトから複数の Lambda を作成します。機能ごとに個別のプロジェクトを自由に作成できます。しかし、アプリケーションと要件の現在の範囲では、実際には必要ありません。3 つのすべての Lambda 関数を 1 つの .NET Lambda プロジェクトに詰め込み、FunctionHandlers を使用してすべての Lambda を AWS に個別にデプロイします。

開始する前に、パッケージ マネージャー コンソールを使用して、次の Nuget パッケージを StudentLambda プロジェクトにインストールしてください。

Install-Package Amazon.Lambda.APIGatewayEvents
Install-Package AWSSDK.DynamoDBv2
Install-Package Newtonsoft.Json

ご存知のように、最初のパッケージは、.NET Lambda 内で Amazon API Gateway コントラクトを使用するためのものです。

DynamoDB パッケージにより、Lambda は DynamoDB と通信できます。DynamoDB がどのように機能するかをご存じない場合は、ここに完全なガイドを書きました。データを AWS DynamoDB テーブルに保存する単純な CRUD ASP.NET Core WebAPI を作成しました。

次に、学生モデルを定義しましょう。StudentLambda プロジェクトのルートで、新しいクラスを追加し、Student.cs という名前を付けます。

namespace StudentLambda
{
[DynamoDBTable("students")]
public class Student
{
[DynamoDBHashKey("id")]
public int? Id { get; set; }
[DynamoDBProperty("first_name")]
public string? FirstName { get; set; }
[DynamoDBProperty("last_name")]
public string? LastName { get; set; }
[DynamoDBProperty("class")]
public int Class { get; set; }
}
}

AWS DynamoDB に移動し、次のように新しいテーブルを作成します。

chrome FCz71W3ljT Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

テーブルを作成すると、AWS がテーブルをクラウドにプロビジョニングするのに数秒かかります。このテーブルにサンプル レコードを追加してみましょう。テーブルを開き、Explore Table Items -> Create Item をクリックします。

JSON ビューに切り替えて、次のようなサンプル レコードを追加します。使用したプロパティは、Student.cs クラスで定義したものとまったく同じであることに注意してください。[作成] をクリックします。

{
"id": 1,
"first_name" : "Mukesh",
"last_name" : "Murugan",
"class" : 10
}

chrome MotUEEQAR1 Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

すべての学生を取得する

DynamoDB テーブルからすべての学生のリストを返すコードを書きましょう。StudentLambda の Function.cs クラスを開きます。デフォルトの FunctionHandler メソッドを削除します。そして、次の関数を追加します。

public async Task<List<Student>> GetAllStudentsAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
var data = await dbContext.ScanAsync<Student>(default).GetRemainingAsync();
return data;
}

したがって、この関数は基本的に DynamoDB テーブル名の学生全体をスキャンし、学生のリストを返します。それと同じくらい簡単です。AWS Lambda からデータにアクセスするために、いくつかの DynamoDB クライアントとコンテキストを作成することに注意してください。

3 つすべてが完了したら、これらの Lambda をデプロイします。理想的には、この Lambda のエンドポイントは <amazon-url>/students [GET] メソッドになります。

学生の作成

次に、Student Lambda の Same Function.cs に、新しい Student レコードの作成を担当する別のメソッドを追加しましょう。以下、関数です。

public async Task<APIGatewayHttpApiV2ProxyResponse> CreateStudentAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
var studentRequest = JsonConvert.DeserializeObject<Student>(request.Body);
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
await dbContext.SaveAsync(studentRequest);
var message = $"Student with Id {studentRequest?.Id} Created";
LambdaLogger.Log(message);
return new APIGatewayHttpApiV2ProxyResponse
{
Body = message,
StatusCode = 200
};
}

したがって、ここでは、クライアントが生徒の詳細を含む JSON 本文を送信することを期待しています。

3 行目では、受信したリクエストの本文を Student オブジェクトに逆シリアル化します。次に、dynamoDb テーブルにアクセスするための DB コンテキストを作成し、学生のレコードをデータベースに保存します。これが完了すると、ステータス コード 200 の応答として成功メッセージがクライアントに返されます。

8 行目で、LambdaLogger インスタンスを使用してメッセージを Lambda の Cloudwatch LogGroup に記録していることがわかります。このエンドポイントは、理想的には <amazon-url>/students [POST] メソッドになります。

ID で生徒を取得

最後のラムダ関数に進み、リクエストで送信された ID に基づいて学生を返すことができる関数を追加しましょう。リクエストのパス パラメータから ID をフェッチする必要があるため、これは多少異なる関数になります。たとえば、デプロイのこのエンドポイントは、<amazon-url>/students/{id} のようになります。

Student Lambda プロジェクトの Function.cs に以下のメソッドをコピペします。

public async Task<Student> GetStudentByIdAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
string idFromPath = request.PathParameters["id"];
int id = Int32.Parse(idFromPath);
var student = await dbContext.LoadAsync<Student>(id);
if (student == null) throw new Exception("Not Found!");
return student;
}

5 行目では、リクエストのパス パラメータ プロパティから学生 ID を抽出しています。取得したら、それを整数に変換し、それを dynamoDb メソッドに渡して、ID で学生を取得します。この生徒の記録は、応答としてクライアントに返されます。

これで、すべてのラムダ関数が作成されました。それらを AWS にデプロイしましょう。

Visual Studio で、StudentLambda プロジェクトを右クリックし、[Publish to AWS Lambda] をクリックします。3 つの機能を順次展開していきます。

以下の画面で注意点が2つあります。関数名は「get-all-students」で、Handler は GetAllStudentsAsync メソッドを指しています。このように、3 つの Lambda をすべて個別に公開しています。あなたは今までにその考えを持っているに違いありません。これらのフィールドを変更したら、[次へ] をクリックします。

devenv lP4870ufPw Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

次の画面で、この Lambda に関連付けられたロールを選択する必要があります。まず、AWSLambdaBasicExecution Role を使用できます。ただし、これには 1 つの問題があります。この特定のロールは、Lambda を実行し、ログを Cloudwatch に書き込むためのアクセスのみを提供します。しかし、DynamoDB テーブルにアクセスする権限はありませんよね? すべての Lambda をデプロイした後、これを修正します。

devenv k3q9el3o6D Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

以上で、get-all-students Lambda をアップロードします。

同様の手順を繰り返して、残りの Lambda をデプロイします。これら 2 つの AWS Lambda のそれぞれに対して、作成済みのロールを必ず選択してください。

devenv 12JZFkHk21 Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

devenv fycfsY0BNP Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

devenv jD6jBn30hv Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

それでおしまい!これまでに作成した Lambda を次に示します。

chrome yqXn6ON0rX Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

DynamoDB アクセス許可の追加。

前述のように、作成したロールに必要な DynamoDB アクセス許可を追加しましょう。AWS IAM に移動します。ポリシーに移動し、次の仕様でポリシーを作成します。ご覧のとおり、AWS サービスとして DynamoDB を選択し、すべての DynamoDB アクションとすべてのリソースを許可しました。

chrome Ql3GcGoy6E Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

特定のロールに完全なアクセス許可を付与することは、必ずしも良い考えではないことに注意してください。しかし、物事をシンプルに保つために、そうしています。本番アプリケーションではこれを行うべきではありません。本当に必要な権限のみを付与してください。

次のページで、ポリシーに名前を付けて作成します。

chrome ycODtFF4xn Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

ポリシーを作成したので、ロールにアタッチしましょう。リストから新しく作成したポリシーを選択し、[アタッチ] をクリックします。次のページで、このポリシーをアタッチするロール/ユーザー/グループを選択する必要があります。

chrome BXL706oAoM Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

私たちの場合、それは lambda_exec_get-all-students です

chrome mAu7ftXH2A Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

ほらね。AWS Lambda で使用されるロールにポリシーを正常にアタッチしました。これで、Lambda には DynamoDb を操作するのに十分な権限が付与されます。

.NET AWS Lambda を使用して Amazon API Gateway を接続する

次は、これらのラムダのそれぞれをトリガーする API ゲートウェイを実際に構築するという、ガイドの重要な部分です。AWS マネジメント コンソールから Amazon API Gateway を開きます。

これまでのところ、 helloである API ゲートウェイを 1 つだけ作成しました。新しい API ゲートウェイを作成します。いつものように、HTTP API タイプを選択し、[ビルド] をクリックします。

ゲートウェイに学生という名前を付け、3 つのすべての Lambda を統合として追加しました。シンプルですね。

chrome j6Rwc9eHTU Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

次のページでは、ルートを構成します。デフォルト値を変更し、以下の構成を追加します。

chrome HTdaHTJd1a Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

  • GET /students は get-all-students を呼び出します
  • GET /students/{id} は get-student-by-id を呼び出します。id はリクエストのパス パラメータです。例: /students/1
  • 最後に、リクエストの JSON ペイロードとして新しい学生の詳細を渡した場合、POST /students は新しい学生を作成します。
     

ステージをデフォルトのままにして、ゲートウェイの作成を続行します。

chrome b5Pqmem97h Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

ほら、それだけです。このエンドポイントを Postman でテストしてみましょう。

まず、get-al-students Lambda をテストしています。<url>/students に GET リクエストを送信しました。予想どおり、学生のリストが応答として表示されます。今のところ、データベースには 1 つのレコードしかありません。

Postman IEQHc2RddV Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

次に、get-student-by-id Lambda をテストしましょう。<url>/students/1 に GET リクエストを送信しました。そして当然、ID 1 の生徒の詳細が返されます。

Postman Z6R9hqnoka Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

最後に、新しい学生を作成しましょう。<url>/students エンドポイントに POST リクエストを学生の詳細とともに送信しました。応答は、学生が ID 2 で作成されたことです!

Postman 7lDzMoDjEr Amazon API Gateway with .NET - AWS Lambda と DynamoDB の統合

また、Create-Student Lambda で小さな Logger を作成したことを覚えていますか? Cloudwatch / Log Groups / create-student に移動して、ログを確認してみましょう。

chrome kBWX1ReSVr Amazon API Gateway with .NET - AWS Lambda & DynamoDB Integrations

ログメッセージもここに出力されていることがわかります。

これで、この包括的な記事は終了です。次の記事では、Lambda オーソライザーを使用して API ゲートウェイを保護する方法について学びます! 今のところ、作成した API ゲートウェイはパブリック エンドポイントです。

重要なヒント: 探索が終了したら、作成した AWS リソースを必ず削除してください。これは、発生するコストを削減するのに役立ちますが、FREE Tier ではかなりの量の無料リクエストを処理できます。

概要

この記事では、.NET で Amazon API Gateway を使い始める方法について学びました。ここでは、Amazon API Gateway と互換性のある基本的な Lambda の作成、DynamoDB への統合、特定のゲートウェイへの複数の Lambda の追加、ロギングなどについて学びました。これにより、AWS サーバーレス アプリケーションを操作するための確かなアイデアが得られます。.NET を使用したこの AWS サーバーレス アプリケーションの次の部分として、API ゲートウェイを保護する方法、および SAM と連携する方法などを探ります。乞うご期待。このニュースレターに従って、私が新しい記事を公開したときに通知を受け取ることができます – https://www.getrevue.co/profile/iammukeshm

この記事が興味深いと思った場合は、同僚や開発者サークルとこの記事を共有してください。プロジェクトのソースコードはこちらにあります  。ありがとう!  

 ソース: https://codewithmukesh.com/blog/amazon-api-gateway-with-dotnet/

#dotnet #amazon #api 

What is GEEK

Buddha Community

.NET を使用した Amazon API ゲートウェイ
Einar  Hintz

Einar Hintz

1602560783

jQuery Ajax CRUD in ASP.NET Core MVC with Modal Popup

In this article, we’ll discuss how to use jQuery Ajax for ASP.NET Core MVC CRUD Operations using Bootstrap Modal. With jQuery Ajax, we can make HTTP request to controller action methods without reloading the entire page, like a single page application.

To demonstrate CRUD operations – insert, update, delete and retrieve, the project will be dealing with details of a normal bank transaction. GitHub repository for this demo project : https://bit.ly/33KTJAu.

Sub-topics discussed :

  • Form design for insert and update operation.
  • Display forms in modal popup dialog.
  • Form post using jQuery Ajax.
  • Implement MVC CRUD operations with jQuery Ajax.
  • Loading spinner in .NET Core MVC.
  • Prevent direct access to MVC action method.

Create ASP.NET Core MVC Project

In Visual Studio 2019, Go to File > New > Project (Ctrl + Shift + N).

From new project window, Select Asp.Net Core Web Application_._

Image showing how to create ASP.NET Core Web API project in Visual Studio.

Once you provide the project name and location. Select Web Application(Model-View-Controller) and uncheck HTTPS Configuration. Above steps will create a brand new ASP.NET Core MVC project.

Showing project template selection for .NET Core MVC.

Setup a Database

Let’s create a database for this application using Entity Framework Core. For that we’ve to install corresponding NuGet Packages. Right click on project from solution explorer, select Manage NuGet Packages_,_ From browse tab, install following 3 packages.

Showing list of NuGet Packages for Entity Framework Core

Now let’s define DB model class file – /Models/TransactionModel.cs.

public class TransactionModel
{
    [Key]
    public int TransactionId { get; set; }

    [Column(TypeName ="nvarchar(12)")]
    [DisplayName("Account Number")]
    [Required(ErrorMessage ="This Field is required.")]
    [MaxLength(12,ErrorMessage ="Maximum 12 characters only")]
    public string AccountNumber { get; set; }

    [Column(TypeName ="nvarchar(100)")]
    [DisplayName("Beneficiary Name")]
    [Required(ErrorMessage = "This Field is required.")]
    public string BeneficiaryName { get; set; }

    [Column(TypeName ="nvarchar(100)")]
    [DisplayName("Bank Name")]
    [Required(ErrorMessage = "This Field is required.")]
    public string BankName { get; set; }

    [Column(TypeName ="nvarchar(11)")]
    [DisplayName("SWIFT Code")]
    [Required(ErrorMessage = "This Field is required.")]
    [MaxLength(11)]
    public string SWIFTCode { get; set; }

    [DisplayName("Amount")]
    [Required(ErrorMessage = "This Field is required.")]
    public int Amount { get; set; }

    [DisplayFormat(DataFormatString = "{0:MM/dd/yyyy}")]
    public DateTime Date { get; set; }
}

C#Copy

Here we’ve defined model properties for the transaction with proper validation. Now let’s define  DbContextclass for EF Core.

#asp.net core article #asp.net core #add loading spinner in asp.net core #asp.net core crud without reloading #asp.net core jquery ajax form #asp.net core modal dialog #asp.net core mvc crud using jquery ajax #asp.net core mvc with jquery and ajax #asp.net core popup window #bootstrap modal popup in asp.net core mvc. bootstrap modal popup in asp.net core #delete and viewall in asp.net core #jquery ajax - insert #jquery ajax form post #modal popup dialog in asp.net core #no direct access action method #update #validation in modal popup

Top 10 API Security Threats Every API Team Should Know

As more and more data is exposed via APIs either as API-first companies or for the explosion of single page apps/JAMStack, API security can no longer be an afterthought. The hard part about APIs is that it provides direct access to large amounts of data while bypassing browser precautions. Instead of worrying about SQL injection and XSS issues, you should be concerned about the bad actor who was able to paginate through all your customer records and their data.

Typical prevention mechanisms like Captchas and browser fingerprinting won’t work since APIs by design need to handle a very large number of API accesses even by a single customer. So where do you start? The first thing is to put yourself in the shoes of a hacker and then instrument your APIs to detect and block common attacks along with unknown unknowns for zero-day exploits. Some of these are on the OWASP Security API list, but not all.

Insecure pagination and resource limits

Most APIs provide access to resources that are lists of entities such as /users or /widgets. A client such as a browser would typically filter and paginate through this list to limit the number items returned to a client like so:

First Call: GET /items?skip=0&take=10 
Second Call: GET /items?skip=10&take=10

However, if that entity has any PII or other information, then a hacker could scrape that endpoint to get a dump of all entities in your database. This could be most dangerous if those entities accidently exposed PII or other sensitive information, but could also be dangerous in providing competitors or others with adoption and usage stats for your business or provide scammers with a way to get large email lists. See how Venmo data was scraped

A naive protection mechanism would be to check the take count and throw an error if greater than 100 or 1000. The problem with this is two-fold:

  1. For data APIs, legitimate customers may need to fetch and sync a large number of records such as via cron jobs. Artificially small pagination limits can force your API to be very chatty decreasing overall throughput. Max limits are to ensure memory and scalability requirements are met (and prevent certain DDoS attacks), not to guarantee security.
  2. This offers zero protection to a hacker that writes a simple script that sleeps a random delay between repeated accesses.
skip = 0
while True:    response = requests.post('https://api.acmeinc.com/widgets?take=10&skip=' + skip),                      headers={'Authorization': 'Bearer' + ' ' + sys.argv[1]})    print("Fetched 10 items")    sleep(randint(100,1000))    skip += 10

How to secure against pagination attacks

To secure against pagination attacks, you should track how many items of a single resource are accessed within a certain time period for each user or API key rather than just at the request level. By tracking API resource access at the user level, you can block a user or API key once they hit a threshold such as “touched 1,000,000 items in a one hour period”. This is dependent on your API use case and can even be dependent on their subscription with you. Like a Captcha, this can slow down the speed that a hacker can exploit your API, like a Captcha if they have to create a new user account manually to create a new API key.

Insecure API key generation

Most APIs are protected by some sort of API key or JWT (JSON Web Token). This provides a natural way to track and protect your API as API security tools can detect abnormal API behavior and block access to an API key automatically. However, hackers will want to outsmart these mechanisms by generating and using a large pool of API keys from a large number of users just like a web hacker would use a large pool of IP addresses to circumvent DDoS protection.

How to secure against API key pools

The easiest way to secure against these types of attacks is by requiring a human to sign up for your service and generate API keys. Bot traffic can be prevented with things like Captcha and 2-Factor Authentication. Unless there is a legitimate business case, new users who sign up for your service should not have the ability to generate API keys programmatically. Instead, only trusted customers should have the ability to generate API keys programmatically. Go one step further and ensure any anomaly detection for abnormal behavior is done at the user and account level, not just for each API key.

Accidental key exposure

APIs are used in a way that increases the probability credentials are leaked:

  1. APIs are expected to be accessed over indefinite time periods, which increases the probability that a hacker obtains a valid API key that’s not expired. You save that API key in a server environment variable and forget about it. This is a drastic contrast to a user logging into an interactive website where the session expires after a short duration.
  2. The consumer of an API has direct access to the credentials such as when debugging via Postman or CURL. It only takes a single developer to accidently copy/pastes the CURL command containing the API key into a public forum like in GitHub Issues or Stack Overflow.
  3. API keys are usually bearer tokens without requiring any other identifying information. APIs cannot leverage things like one-time use tokens or 2-factor authentication.

If a key is exposed due to user error, one may think you as the API provider has any blame. However, security is all about reducing surface area and risk. Treat your customer data as if it’s your own and help them by adding guards that prevent accidental key exposure.

How to prevent accidental key exposure

The easiest way to prevent key exposure is by leveraging two tokens rather than one. A refresh token is stored as an environment variable and can only be used to generate short lived access tokens. Unlike the refresh token, these short lived tokens can access the resources, but are time limited such as in hours or days.

The customer will store the refresh token with other API keys. Then your SDK will generate access tokens on SDK init or when the last access token expires. If a CURL command gets pasted into a GitHub issue, then a hacker would need to use it within hours reducing the attack vector (unless it was the actual refresh token which is low probability)

Exposure to DDoS attacks

APIs open up entirely new business models where customers can access your API platform programmatically. However, this can make DDoS protection tricky. Most DDoS protection is designed to absorb and reject a large number of requests from bad actors during DDoS attacks but still need to let the good ones through. This requires fingerprinting the HTTP requests to check against what looks like bot traffic. This is much harder for API products as all traffic looks like bot traffic and is not coming from a browser where things like cookies are present.

Stopping DDoS attacks

The magical part about APIs is almost every access requires an API Key. If a request doesn’t have an API key, you can automatically reject it which is lightweight on your servers (Ensure authentication is short circuited very early before later middleware like request JSON parsing). So then how do you handle authenticated requests? The easiest is to leverage rate limit counters for each API key such as to handle X requests per minute and reject those above the threshold with a 429 HTTP response. There are a variety of algorithms to do this such as leaky bucket and fixed window counters.

Incorrect server security

APIs are no different than web servers when it comes to good server hygiene. Data can be leaked due to misconfigured SSL certificate or allowing non-HTTPS traffic. For modern applications, there is very little reason to accept non-HTTPS requests, but a customer could mistakenly issue a non HTTP request from their application or CURL exposing the API key. APIs do not have the protection of a browser so things like HSTS or redirect to HTTPS offer no protection.

How to ensure proper SSL

Test your SSL implementation over at Qualys SSL Test or similar tool. You should also block all non-HTTP requests which can be done within your load balancer. You should also remove any HTTP headers scrub any error messages that leak implementation details. If your API is used only by your own apps or can only be accessed server-side, then review Authoritative guide to Cross-Origin Resource Sharing for REST APIs

Incorrect caching headers

APIs provide access to dynamic data that’s scoped to each API key. Any caching implementation should have the ability to scope to an API key to prevent cross-pollution. Even if you don’t cache anything in your infrastructure, you could expose your customers to security holes. If a customer with a proxy server was using multiple API keys such as one for development and one for production, then they could see cross-pollinated data.

#api management #api security #api best practices #api providers #security analytics #api management policies #api access tokens #api access #api security risks #api access keys

Autumn  Blick

Autumn Blick

1601381326

Public ASX100 APIs: The Essential List

We’ve conducted some initial research into the public APIs of the ASX100 because we regularly have conversations about what others are doing with their APIs and what best practices look like. Being able to point to good local examples and explain what is happening in Australia is a key part of this conversation.

Method

The method used for this initial research was to obtain a list of the ASX100 (as of 18 September 2020). Then work through each company looking at the following:

  1. Whether the company had a public API: this was found by googling “[company name] API” and “[company name] API developer” and “[company name] developer portal”. Sometimes the company’s website was navigated or searched.
  2. Some data points about the API were noted, such as the URL of the portal/documentation and the method they used to publish the API (portal, documentation, web page).
  3. Observations were recorded that piqued the interest of the researchers (you will find these below).
  4. Other notes were made to support future research.
  5. You will find a summary of the data in the infographic below.

Data

With regards to how the APIs are shared:

#api #api-development #api-analytics #apis #api-integration #api-testing #api-security #api-gateway