こんにちは、k_ukiです。
現在、「AWSではじめるクラウド開発入門」という書籍の12章を進めています。
ここでは、10章,11章で学習したサーバレスクラウド（Lambda,S3,DynamoDB）を使用し、シンプルなWebアプリを実装するという内容でした。今回のハンズオンで学んだことをここにまとめていきます。
アプリの説明
アプリの概要
利用者が考えて作った俳句を投稿し、ユーザがいいねできるようなSNSアプリです。
また、アプリ名を"Bashoutter"としています。
機能要件は以下の通りです。
- 俳句の一覧を取得
- 俳句を新規投稿する。
- 俳句にお気に入り表を一つ入れる
- 俳句を削除する
API
上記の機能要件を満たすための最小限の設計として4つのREST APIを実装しています。
| GET/haiku | 俳句の一覧を取得 |
| POST/haiku | 俳句を新規投稿する。 |
| PATCH/haiku/{item_id} | 俳句にお気に入り表を一つ入れる |
| DELETE/haiku/{item_id} | 俳句を削除する |
設計
今回デプロイするアプリの設計を以下に簡単に示す。
- クライアントからのAPIリクエストをAPI Gatewayに送信しAPIのURIで指定されたLambda関数へ転送する。
- APIのパスごとに別のLambdaを用意する
- 俳句の情報をDynamoDBに登録する。
- LambdaにはDynamoDBへのアクセス権を与える
- webページのコンテンツ（htmlファイル等）を表示するためのS3バケットを用意する。クライアントはS3バケットにアクセスしページを取得する。
導入に必要な用語
S3＜ Public access mode
今回使用するS3バケット作成用のコードには以下の一文があります。
public_read_access=True
S3にはPublic access mode という機能があります。この機能をOnにすることで認証なしで誰でもコンテンツを閲覧できるようになります。今回はwebページで表示するためのhtmlファイルなどを誰でも閲覧できるようにするために適応しています。
ハンドラ関数
送られてきたAPIリクエストを基に処理を行う関数のことをハンドラといいます。
IAM(Identity and Access)
IAMは、リソースが他のリソースに対してどのような権限を持っているかを定義するものです。
例えば、Lambdaはデフォルトの状態でほかのリソースにアクセスする権限を持っていません。そのため、デフォルトの状態ではDynamoDBにアクセスすることは不可能であるため、それを許可するIAMをLambdaに付与する必要があります。
API Gateway
API GatewayはAPIのリクエストに従ってLambdaやS3などに接続を行う機能となっています。また、各リソースの処理の結果もAPI Gatewayを通り返されます。
デプロイを実行する。
早速デプロイを実行してみます。まず、プロジェクトのディレクトに移動し以下のコマンド実行します。
$ python3 -m venv .env
$ source .env/bin/activate
$ pip install -r requirements.txt
$ cdk deploy
入力後、以下の画面が表示されデプロイが完了したことがわかります。
また、コンソールを確認するとデプロイしたアプリ名が表示されました。
本当にちゃんとデプロイが完了したのか確認します。
API Gatewayのコンソールのアプリ名をクリックすると、それぞれのメソッドを確認することができます。
次にS3のコンソールにアクセスします。
バケット名をクリックすることで中身を確認することができます。中にはウェブページの静的コンテンツが存在していたので正しくデプロイで来たことが確認できた。
APIリクエストを送信してみる
早速デプロイしたアプリにAPIリクエストを送信して操作してみようと思います。
まず、デプロイ実行時に得られたAPIのURLをコマンドライン変数に登録しておきます。
$ export ENDPOINT_URL= "APIのエンドポイントのURL"
登録が完了したら、俳句の一覧を取得してみます。現時点では何も登録していないので空の配列が返されました。
$ http GET "${ENDPOINT_URL}/haiku"
次に俳句の投稿を行ってみます。正常に作成されると以下のメッセージが出力されます。
http POST "${ENDPOINT_URL}/haiku"\
username="松尾芭蕉" \
first="閑さや" \
second="岩にしみ入る" \
third="蝉の声"
投稿が完了したので再度GETメソッドを実行してみます。
今投稿した内容を確認できました！
次に、PATCHメソッドを使用して俳句にいいねをしてみます。
以下のコマンドを実行してみます。
http PATCH "${ENDPOINT_URL}/haiku/(GET メソッドで得たitem_id)"
再度GETメソッドを実行したところ、likesが1.0になっており更新処理が完了したことがわかります。
最後に、DELETEメソッドを実行してみます。
http DELETE "${ENDPOINT_URL}/haiku/(GET メソッドで得たitem_id)"
再度GETメソッドを実行すると空の配列が返されたので無事削除が完了したことがわかりました。
GUIを動かしてみる
今まではCLI上でアプリを操作してきました。次はGUI上でアプリを操作してみます。
アクセスするにはデプロイ時に出力されたURLにアクセスします。
ページが表示されたら一番上にAPI ENDPOINT URLを入力し必要な情報を入力したところ、ちゃんと投稿することができました。
最後に
以上が12章のハンズオンで実践した内容になります。サーバレスのサービスの使い方に加えAPIリクエストやハンドラ関数などの知識も学ぶことができました。