c#＋Lambda＋API Gatewayで最小構成のRestAPIを作成する方法

直近ではPythonを使ってLambda+serverless framework+APIGatewayでRestAPIを作成していたのですが、そちらのプロジェクトが終わって知見を広めようとバックエンド系の言語を調べていた所、C#の文字を発見！
これまでC#はwindows用のアプリを開発する言語として利用してきたので、バックエンドでも使えることを知ってびっくりしました。

まだまだ初歩も初歩の部分をやっているのですが、初歩の部分のハードルがかなり高くて、自分でも2回目やるときにまた調べなきゃいけないことになりそうだったので、最小のAPIを作成してデプロイするところまでを手順化してみます！

環境

windows11
VisualStudio2022Community 17.8.6
.NET6

まずVisualStudioを変更する

1. VisualStudioInstallerを起動して、変更を選択します。
2. ASP.NETとWEB開発にチェックを入れて右下の変更を押します。
3. しばらく待つとVisualStudioが変更されるので、これで完了です！
   

プロジェクトの作成

1. 新しいプロジェクトの作成 をクリック
2. テンプレートからASP.NET Core Web APIを選択
   
3. 任意のプロジェクト名とソリューション名を設定し、場所の指定をし、次へを押す
4. 追加情報の設定は基本的にはデフォルトで問題ないかなと思います。
   フレームワークは.NET6.0、認証の種類はなし、HTTPS用の構成とOpenAPIサポート...とコントローラーを使用するにチェック☑を入れる。
   

これでプロジェクトの作成が完了しましたね！

この時点でローカルホストではAPIが動作するようになっているので、F5 or Ctrl+F5で実行するとSwaggerViewがブラウザで立ち上がってローカルホストでAPIを叩けるようになります。

NuGetパッケージのインストール

1. まずはLambdaにデプロイするために必要なNuGetパッケージをインストールします。
2. プロジェクトタブからNuGetパッケージの管理を選択し、参照タブで検索窓にamazon.lambda.aspと入力する。
3. そうすると、Amazon.Lambda.AspNetCoreServer.Hostingというパッケージが出てくるので、インストールします。
   
4. ポップアップが表示されたら同意するを押して、インストールの完了です。

プロジェクトファイルの編集

1. まずは.csprojファイルを編集します。
2. PropertyGroupセクションに<AWSProjectType>Lambda</AWSProjectType>という文言を追加します。

testAPI.csproj

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <AWSProjectType>Lambda</AWSProjectType>
  </PropertyGroup>

3. これで、このプロジェクトがLambda関数を開発しているとVisualStudioに認識させることができます。

<AWSProjectType>Lambda</AWSProjectType>を追加する前と後では、.csprojファイルを右クリックしたときに表示されるメニューが違います。
デフォルトではPublish to AWS...とAWSのすべてのサービスに対してデプロイするメニュー(使ったことがないので詳しくは知りません)ですが、AWSProjectTypeプロパティにLambdaを設定すると、Publish to AWS Lambda...というようにLambdaにデプロイする用のメニューに進化します。

Lambda関数にHTTPリクエストを送信するイベントを設定する

1. 難しいことが書いてありますが、要はLambdaをトリガーする際のイベントを設定するというだけの事です。
   今回はRestAPIでLambdaの発火を行うので、そのように設定します。
2. Program.csを開き、var app = builder.Build();の上の行にbuilder.Services.AddAWSLambdaHosting(LambdaEventSource.RestApi);を追加します。

Program.cs

builder.Services.AddSwaggerGen();

builder.Services.AddAWSLambdaHosting(LambdaEventSource.RestApi);   //ここに追加

var app = builder.Build();

これだけでOKです！

RestApiの部分をHttpApiにすることでHTTP APIでも発火できます。

Lambda関数を作成する

1. AWSコンソールからLambdaを開きます。
2. 関数を作成ボタンをクリックして、関数の作成画面に移行します。
3. 関数名に任意の名前を入力し、ランタイムに.NET 6(C#/PowerShell)を選択して関数を作成ボタンを押す。
4. AWSコンソールでの操作は以上です。

Lambdaにデプロイする

1. ここまで出来たら、ついにLambdaにローカルの関数をデプロイしていきます。

2. まずはアセンブリ名を確認します。

   1. .csprojを右クリックし、プロパティを開きます。
   2. アプリケーションタブのアセンブリ名を確認して必要であればメモしておきます。

3. .csprojを右クリックし、Publish to AWS Lambda...をクリック。

4. すると、Lambdaデプロイする用のインターフェースが表示されます。

5. FunctionNameでRe-deploy to existingにチェックを入れて、先ほどAWSコンソールで作成したLmabda関数を選択して、Handlerにアセンブリ名を入力してNextを押します。

6. デプロイの設定画面が表示されるので、RoleNameには、先ほど作成したLambda関数の名前がついているものを選択してください。(例 : test_lambda_role_xxxxxxxxx)

7. 他の設定もできますが、今回はそれ以外は特に触れずに、Uploadボタンを押します。

8. 何事もなければ、publishingと表示され、アップロード作業が完了すると自動的にクローズします。

9. その後表示される画面でテストができるのですが、今回の構成ではテストしてもエラーが出るので、パスします。

10. これで、Lambda関数側は完了になります！

API GatewayでAPIを作る

1. これまで色々やってきたLambda関数を発火する用のAPIを作成します。
2. AWSコンソールにアクセスし、APIGatewayのコンソールを開きます。
3. 作成出来るAPIの種類が表示されるので、REST APIの構築をクリックする。(APIの種類が表示されず、既存のAPI一覧が表示される場合は、APIを作成ボタンをクリックすると表示されます)
4. API名だけ任意のものを付けて、他はデフォルトのままAPIを作成をクリック。
5. リソースを作成をクリック。
6. プロキシのリソースをONにして。リソース名に{proxy+}と入力してリソースの作成をクリックします。
   
7. 右側のリソースツリーから/{proxy+}を選択して、メソッドを作成ボタンをクリック。
8. メソッドタイプは、今回のLambda関数は天気を取得するものなので、GETを選択します。
9. Lambda関数には、先ほど作成したLambda関数を選択し、メソッドを作成をクリックします。
10. 続いて、リソースツリーから、ANYを選択し、統合を編集ボタンをクリックします。
11. Lambda関数で先ほど作成したLambda関数を選択し、他は何も触れずに保存を押します。
12. ここまで出来たら、右上にあるAPIをデプロイをクリックし、ステージを選択プルダウンをクリックし、新しいステージで、ステージ名には任意の名前を付けてデプロイボタンをクリックします。
13. これで、APIを作成す、Lambdaと紐づけることができたので、あとは動作チェックだけです。

実際に動作チェックする

1. あとは簡単で、実際にAPIGatewayで作成されたURLにアクセスして、APIが動いているか確認するだけです。
2. まず、APIGatewayのコンソールを表示して、作成したAPIをクリックします。(先ほどAPIを作成した画面のままならパスで大丈夫です)
3. 左側のサイドバーからステージの項目をクリックします。
4. すると、ステージの詳細という画面が表示されるので、そこの中央あたりにあるURLを呼び出すというセクションに書いてあるURLをコピーします。
5. 新しくタブを開いて、先のURLを張り付けます。
6. これだけでは{"message":"Missing Authentication Token"}が表示されてしまうはずなので、エンドポイントを編集します。
7. いったんVisualStudioに戻って、Controllers\WeatherForecastController.csを開きます。
8. ここに書いてあるのが実際のLambda関数なのですが、クラス名がエンドポイントになっています。

WeatherForecastController.cs

namespace testAPI.Controllers
{
   [ApiController]
   [Route("[controller]")]
   // Routeアトリビュートでの指定によるが、controllerを指定した場合、
   // クラス名からControllerを引いたものがエンドポイントになる
   public class WeatherForecastController : ControllerBase

9. この場合は、WeatherForecastがエンドポイントとなるので、{先ほどコピーしたURL}/WeatherForecastをブラウザで叩きます。
10. すると、

result

 [{"date":"2024-02-27T09:13:18.9855303+00:00","temperatureC":22,"temperatureF":71,"summary":"Mild"},{"date":"2024-02-28T09:13:19.0011868+00:00","temperatureC":14,"temperatureF":57,"summary":"Hot"},{"date":"2024-02-29T09:13:19.0011904+00:00","temperatureC":3,"temperatureF":37,"summary":"Freezing"},{"date":"2024-03-01T09:13:19.0011907+00:00","temperatureC":4,"temperatureF":39,"summary":"Mild"},{"date":"2024-03-02T09:13:19.0011908+00:00","temperatureC":26,"temperatureF":78,"summary":"Warm"}]

11.このようにブラウザに表示されれば無事APIとして動作していることになります！

振り返り

C#でAPIを作れるには作れるのですが、Pythonほど日本語の資料や記事も無く、AWSの公式リファレンスでもあまり取り上げられていないので、なかなか難しかったです。
幸い、海外の方が動画でチュートリアルを挙げてくださっていて、その通りにしたらしっかりAPIが作れたので、今回はそのまま翻訳したような形にはなりましたが、記事にしてみました。
気が向いたら、C#で実際に実用的なAPIを作成したり、そもそものASP.NET Cre WEB APIでデフォルト作成されるフォルダの解説なんかも書いてみようと思います。

---

参考にした動画 : Building a Serverless ASP.NET Core Web API using AWS Lambda and Amazon API Gateway REST API