メインコンテンツまでスキップ

Amazon API Gateway

参考URL
RestとHTTP違い Amazon CloudFrontでAPI Gatewayの痒いところに手を届ける

アプリケーションをユーザに公開する場合、それがGUIであってもインターフェースが必要になる。
Webアプリケーションを公開する場合にはWeb APIを利用するのが一般的であり、AWSもAPIをフルマネージドで活用するためのAPI Gatewayを提供している。

Amazon API Gatewayとは？​

Amazon APIGatewayは規模にかかわらず、簡単にAPIの作成と保護、そして公開、モニタリングが可能なフルマネージドサービス。
API Gatewayは簡単にAPIを作成し公開できるサービスでかつ、APIに求められるさまざまな機能をカバーしている。
そしてAPI Gatewayはクライアントからリクエストを受け取ってそれをバックエンドに渡し、バックエンドからレスポンスを受け取ってクライアントに返す。
プロキシのような働きをしている。

API Gateway特徴​

スケーラビリティ
高トラフィックの場合にも自動的にスケールアウトできる

ヘルスチェックと負荷分散
ヘルスチェックと負荷分散をサポートしている

ユーザー認証と認可
AWS Cognitoやカスタム認証基盤と統合することでユーザー認証と認可を行うことができる

設定の複雑さ
よりシンプルに設定できるが、一部の高度な設定は制限されている

コスト
リクエスト数やデータ転送量に基づく

HTTPプロキシとして進化した経緯​

参考URL

今までのAPI Gatewayでは、HTTPプロキシとして利用するには、通したいリクエストのすべてのリソースパスとメソッドを設定する必要がありました。これが非常に面倒でした。

だが、大量に設定する必要のあったものが /{proxy+} だけで簡単にオールスルーのプロキシが作れるようになった。

利用シーンの抜粋

  • レートリミットをかける API Gatewayは比較的楽にレートリミットをかけることができるので、既存APIにGatewayを挟んで使う
  • とりあえず全部Lambdaに飛ばしてゴニョゴニョする リクエストパスに応じて振り分けるとか

Lambdaからのレスポンス形式​

以下のようにしないとAPI Gatewayが502を返してしまう。

{
    "statusCode": httpStatusCode,
    "headers": { "headerName": "headerValue", ... },
    "body": "..."
}

API GatewayとCloudFrontの違い​

API GatewayがListenするのはHTTPSのみで、HTTPリクエストを受け付けることはできません。 一方CloudFrontはHTTPとHTTPSの両方のリクエストを受けられるので、CloudFrontを経由することでAPI GatewayへのリクエストをHTTPで受けることができます。

API Gatewayの種類​

参考URL

2種類ある。
REST API（v1）やHTTP API（v2）
※HTTP APIの方が後発で機能が少ない分、高速かつ料金が安い。

Serverless Frameworkを使用する場合​

API GatewayでServerless Frameworkを使用する場合の注意点

Serverless Frameworkを使用する場合 REST APIを使用する場合はhttp HTTP APIを使用する場合はhttpApiを設定する。

そもそもAPIとは?​

アプリケーションが呼び出せば、予期した結果を返されるような仕組み。

アクセス制限周り​

API Gatewayには、APIキー認証以外にアクセス制限の機能がありません 手前にCloudFrontを置くことで、CloudFrontに統合されたAWS WAFのアクセス制限機能を設定することが可能。

また、API Gatewayへの直アクセスを禁止したい場合は、前述のAPIキー認証を有効化し、先日追加されたオリジンへのヘッダー追加機能でCloudFrontのオリジン設定にx-api-keyヘッダー（独自ヘッダー）を追加、設定することで対応できます。

キャッシュを細かく設定したい​

API Gateway の API キー​

Amazon API GatewayでAPIキー認証を設定する 参考URL

Amazon API GatewayでAPIキー認証を設定すればip制限よりもう少し手軽にセキュアにできる。

API GatewayをCloudFrontでラップする。​

参考URL

API Gatewayの前にCloudFront Distribution を使用することで、APIGatewayのパフォーマンスを向上させることができます。API Gatewayのエッジ最適化 API エンドポイントを使用すると、最寄りのCloudFront Point of PresenceでAPI呼び出しを終了できます。

cloudfrontが前段にくる。利用する理由としてはキャッシング動作を制御するが主な理由。

API Gatewayの前でCloudFront Distributionを使用する理由

  • レイテンシーを削減
  • セキュリティを強化する
  • キャッシング動作を制御する
  • APIのTLS設定を制御する。

Lambdaからエラーレスポンスが返ってきた時に処理をする​

参考URL

エラーをthrowしても処理できないっぽい（できそうだけど）
現状一番簡単なのはエラーをcatchした後、ステータスコードと一緒にJSONレスポンスとして返せば良さそう。

タグ:
に最終更新