ブログ

HOME
ブログ
仮想システム
AWSサーバレスアーキテクチャーNo3：API Gateway

2021年12月23日 / 最終更新日 : 2022年11月20日 MikoshibaHiroyuki 仮想システム

AWSサーバレスアーキテクチャーNo3：API Gateway

AWSのホームページの初心者ハンズオンにある「サーバーレスアーキテクチャで翻訳 Web API を構築する」の内容を自分のAWSアカウントでやってみました。

前回投稿の Lambda、Translate を実装した続きで、３パート目です。
ざっくりと基本構成を図で表してみて、この中の API-Gateway のみの構成です。

Amazon API Gateway の特徴

サーバーをプロビジョニング/管理することなく、APIを作成・管理できるマネージドサービス
可用性の担保、スケーリング、API キー管理といった API 開発で必要なことをAPI Gateway に任せることで、開発者はビジネスの差別化に繋がる作業に集中できる
REST API と WebSocket に対応
リクエストベースの料金体系（REST API の場合）
実行回数（AWSサインアップから１年間の無料枠あり）( + キャッシュメモリ量 ) + データ転送料金

API Gateway を⽤いた API 開発の主要な流れ

①リソースと　　
　メソッドタイプ
の定義

←API全体の設定→　←ーーーーーーーー　　個別メソッド定義　　ーーーーーーーーー→　 ←API全体の設定→

メソッドリクエスト：リクエストの受付に関する設定を⾏う

認証の設定
受け付けるクエリパラメータ
必須とするHTTPヘッダの設定

統合リクエスト：バックエンドの種別を選択する

Lambda関数
HTTP
Mock
AWSサービス
VPCリンク

統合リクエスト　→　統合レスポンス

バックエンドへのInput、バックエンドからのOutput変換することができる
プロキシ統合を利用することで、変換せずにパススルーすることも可能

メソッドレスポンス

リクエストに対する最終的なAPI Gatewayとしてのレスポンスに関する設定

ステータスコード
HTTPレスポンスヘッダなど

API Gateway を単体で使う：設定手順

Mock データを返す API を作成する

新規に API を作成する
sample リソースを作成し、GETメソッドを作成
統合タイプとして Mock を選択する
（まだ Lambda 関数との連携は行わず、固定の JSON を返す）
dev ステージにデプロイする
API を試しに実行してみる

それでは設定していきましょう！

新規にAPIを作成する

検索窓「API」から「API Gateway」をクリック

「REST」を選択

「新しいAPI」を選択

「translate-api」と名前を付けた

「リージョン」のまま

「APIの作成」をクリック

API ごとにデプロイ

ステージを作成し、そのステージのみにデプロイ可能

sample リソースを作成し、GETメソッドを作成

「sample」とリソース名を設定

「リソースの作成」をクリック

下のイメージでプルダウンから「GET」をクリック

✔　をクリックすると確定されて、右画面が展開される。

今回は「Mock」を選択

「保存」をクリック

統合タイプとして Mock を選択する
（まだ、Lambda 関数との連携は行わず、固定のJSONを返す）

リソース x メソッドごとに API のフローを定義する

ハンズオンでは、「すべてのヒントを非表示」をクリック

固定のJSONを返す場合は、

「統合レスポンス」をクリック

▶　を展開

マッピングテンプレート　を展開し、

「application/json」をクリック

{
    "statusCode": 200,
    "body": {
        {
            "report_id": 5,
            "report_title" : "Hello, world"
        },
        {
            "report_id": 7,
            "report_title" : "Good morning!"
        }
    }
}

JSONコードをコピペして、
「保存」をクリック