AWS Black Belt Tech シリーズ 2015 - Amazon API Gateway

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Build, Deploy & Manage your APIs
Amazon API Gateway概要
Amazon Data Service Japan K.K.
Solutions Architect
Keisuke Nishitani...

Look Back API, again

API
• Application Programming Interface
• アプリケーションから利用する処理のためのイン
ターフェース
• WebAPI
– Webベースのシステムで用意される
– HTTPをベースにデータをやり取りする...

急速に増えるAPI
2418
10302
0
2000
4000
6000
8000
10000
12000
6-05
10-05
2-06
6-06
10-06
2-07
6-07
10-07
2-08
6-08
10-08
2-09
6-0...

APIの重要性
• エコシステムを形成できる
• システム間連携
– 外部サービスとの連携
– その逆も
• 疎結合（マイクロサービス）
– フロントエンドとバックエンドのデカップリング
• フロントエンドの多様化
– HTML5/JS
– モ...

AWSには数多くのAPI
AWS自身がAPIを提供する中で多くの教訓を得ている

API管理の課題

API管理の課題
提供するAPIのバージョン管理
API利用状況のモニタ、管理とマネタイズ
APIに対する認証とアクセス権の管理
トラフィック管理とAPIエンドポイントのアタックからの保護
インフラのセットアップおよび管理とメンテナンス

クラウドネイティブ世代の
API管理サービス

Amazon API Gateway

Amazon API Gateway
提供するAPIのバージョン管理
API利用状況のモニタ、管理とマネタイズ
APIに対する認証とアクセス権の管理
トラフィック管理とAPIエンドポイントのアタックからの保護
インフラのセットアップおよび管理と...

Amazon API Gateway
複数バージョンとステージ
API利用状況のモニタ、管理とマネタイズ
APIに対する認証とアクセス権の管理
トラフィック管理とAPIエンドポイントのアタックからの保護
インフラのセットアップおよび管理とメンテ...

Amazon API Gateway
複数バージョンとステージ
APIキーの作成と配布
APIに対する認証とアクセス権の管理
トラフィック管理とAPIエンドポイントのアタックからの保護
インフラのセットアップおよび管理とメンテナンス

Amazon API Gateway
複数バージョンとステージ
APIキーの作成と配布
リクエスト時におけるAWS SigV4の利用
トラフィック管理とAPIエンドポイントのアタックからの保護
インフラのセットアップおよび管理とメンテナンス

Amazon API Gateway
複数バージョンとステージ
APIキーの作成と配布
リクエスト時におけるAWS SigV4の利用
リクエストのスロットリングとモニタリング
インフラのセットアップおよび管理とメンテナンス

Amazon API Gateway
複数バージョンとステージ
APIキーの作成と配布
リクエスト時におけるAWS SigV4の利用
リクエストのスロットリングとモニタリング
バックエンドとしてAWS Lambdaが利用可能

AWS Lambda

AWS Lambda
• インフラを一切気にすることなくアプリケー
ションコードを実行できるコンピュートサービ
ス
– 実行基盤は全てAWSが管理
– AWSサービスと連携させることで簡単にイベントドリブンなア
プリケーションを実装可能
– コ...

Amazon API Gateway
レスポンスをキャッシュ可能
CloudFrontを利用したレイテンシの軽減とDDoS対策
iOS、AndroidとJavaScript向けSDKの自動生成
Swaggerのサポート
Request / Re...

従来のアーキテクチャ
・認証API
・データ保存API
Web DB
LB

クラウドネイティブなアーキテクチャ
Lambda
（ロジック）
API Gateway
DynamoDB
（データ保存）

サーバレスで
全部できます

サーバレスで
全部できます
やりたいこと
だけに集中できる

サーバレスで
全部できます
ビジネスロジック
だけに集中できる

クラウドファーストから
クラウドネイティブへ

REST APIについて

RESTとは
• Representational State Transfer
• Roy Fieldingが提唱したWebのソフトウェア
アーキテクチャの1つ
• RESTの原則に則ったAPIをRESTfulという

RESTの特徴
• リソース指向
• URIによるリソースの識別
• ステートレス
• HTTPメソッドを利用した操作

リソース指向
• リソースとは名前を持つあらゆる情報のこと
– 東京の天気
– 今日のニュース
– Amazonの株価
• 全てのリソースはURIで表現する
– URIがリソースそのものを示す
– URIとは1対1の関係
• 時間、条件によって...

URI
• Uniform Resource Identifier
• リソースを特定するもの
– 例）https://api.example.com/resouces/1234
• 名詞で構成
– 表現するのはあくまでもリソースでありアクショ...

ステートレス
• クライアントとサーバ間の接続に状態を持たな
い
• （理想は）リクエストの1つ1つにそれを処理す
るにあたって必要な情報を全て含むこと
• 状態を持たないのでスケーラビリティの確保が
容易になる

例：ステートフルなやり取り
いらっしゃいませ。○○バーガーへようこそ
ハンバーガーセットをください
サイドメニューはいかがなさいますか？
ポテトをください
ドリンクはいかがなさいますか？
はい
コーラをお願いします
以上でよろしいですか？
お会...

例：ステートレスなやり取り
いらっしゃいませ。○○バーガーへようこそ
ハンバーガーセットをください
サイドメニューはいかがなさいますか？
ハンバーガーセットをポテトで
お願いします
ドリンクはいかがなさいますか？
ハンバーガーセットをポテトと
...

HTTPメソッド
• URIで示すリソースに対して何を行うかで利用するメ
ソッドを選択する
• HTTPで定義されているメソッドを利用
• GET/POST/PUT/DELETEおよびPATCHを主に利用する
HTTPメソッド意味 CRUDと...

POST、PUTそしてPATCH
• POSTとPUTはともにリソースの作成が行える
– リソースの作成には一般的にはPOSTを利用
– PUT
• クライアントが指定したURIのリソースを作成
• クライアント側でリソース名を作成する
• サ...

HTTPステータスコード
• 処理の実行結果はHTTPステータスコードで表
現
– HTTPステータスコードに意図を込める
• 400系はクライアント系のエラー
– クライアントのリクエストに問題がある場合
– 指定されたリソースが見つからない...

HTTPステータスコード
HTTPステータスコード意味例
200 OK リクエストに成功し、情報とともにレスポンスを返す場合 GETによるリソース情報の参照
201 CREATED リクエストは成功し、新しく作成されたリソースが返される P...

Amazon API Gatewayの動作

APIコールの流れ
Internet
Mobile Apps
Websites
Services
API
Gateway
AWS Lambda
functions
AWS
API Gateway
Cache
Endpoints on
Amazo...

API作成の流れ
1. 新規APIセットを作成
2. リソースおよびメソッドを定義
– メソッドを作成した時点でテスト可能となる
– 外部に公開はまだされていない状態
3. ステージへのデプロイ
– ステージは本番、開発といったデプロイ環境の管...

API詳細
• API自身を最上位とした階層構造になっている
• API内にリソースを定義
– 複数定義
– リソース名がURLのパスの一部となる
– ネストすることも可能 ex) /pets/{petId}
• 各リソースにメソッドを定義
–...

APIのデプロイ
• APIはステージにデプロイされる
• ステージはそれぞれ個別の環境を表す
• ステージ名はURIの一部となる
– 例:
Dev (e.g. awsapigateway.com/dev)
Beta (e.g. awsapig...

APIの複数バージョンとステージ
API 1 (v1)
Stage (dev)
Stage (prod)
API 2 (v2)
Stage (dev)

APIの呼び出し
• デプロイ後から呼び出し可能
– 呼び出したいメソッドにも寄るがシンプルなGETなどの場合ブラウザ上か
らも可能
• my-api-id
– API作成時に払い出される識別子
• region-id
– APIが作成されたリ...

独自ドメイン
• エンドポイントとして独自ドメインを利用可能
– 独自ドメインでAPI提供が可能
– SSL証明書を用意し、API Gatewayにアップロードする
– 利用しているDNSにDistribution Domain Nameに対す...

ダッシュボード
• API Calls
– 呼び出し回数
• Latency
– リクエストを受け取ってから応答
するまでの時間（ミリ秒）
• 4xx Error
– 4xxを返した回数
• 5xx Error
– 5xxを返した回数

メソッド設定

メソッド設定

Method Request

Method Request
• Authorization type
– NONEもしくはAWS_IAMを選択
– AWS_IAMの場合、正しいIAMロールがセットされているIAMユーザのみがメソッド実行可能とな
り、リクエストに署名が必要と...

URL Query String Parametersの例
• この場合、/<resource>?hoge=fugaといった
リクエストを受け付ける

IAMロール
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"apigateway:method-type"
],
"Resource": ...

Integration Request

Integration Request
• バックエンドとのやり取りに関する設定
• Integration Type
– 利用するバックエンドの種別と関連する情報を設定
• Integration TypeがLambda以外の場合は以下の設定...

Integration Request（Integration Type）
• Lambdaファンクション
• HTTP Proxy
– EC2上で構築したWebAPIなどを利用する場合
– 外部のWebサービスを呼び出すことも可能
– エンド...

Method Response

Method Response
• 返すHTTPステータスコードごとにカスタムヘッダやカスタムデータを返すことが可
能
• シンプルに200だけをOutput passthoroughで返すのであれば設定しなくても問題
ない

Integration Response

Integration Response
• バックエンドの結果を元に特定のHTTPステータスコードを返すた
めの設定
– 標準ではステータスコード200についてのみ設定されている
– バックエンドがLambdaファンクションの場合、エラーメッ...

Integration Response（Lambdaの場合）

Integration Response（HTTP Proxyの場合）

APIキーの使用

APIキー
• APIキーを有効にすることでAPI Gatewayが払い出すAPIキーを使用した
メータリングが可能
– 正しいAPIキーを含まないリクエストはエラーになる
– API/ステージレベルで設定可能
• リクエストのヘッダにAPIキ...

AWS Sigv4の活用、もしくはカスタムヘッダの利用
• APIコールの署名と認可にAWS Sigv4を利用可能
– Amazon CognitoとAWS Security Token Service(STS)のようなテンポラリ
クレデンシャ...

スロットリングとキャッシュ

スロットリング
• メソッド単位でのスロットリングを提供
– ステージ単位で全体的に同一設定にすることも、個々のメソッドに対して個別
に設定することも可能
– スロットリングによりバックエンドのパフォーマンスと可用性を維持
– 許容するリクエス...

レスポンスのキャッシング
• レイテンシ減とバックエンドへのトラフィック軽減
– キャッシュがあった場合、バックエンドを呼び出すことなくレスポンス
• ステージ単位のキャッシュプロビジョニング
– 0.5GBから最大237GBの間でプロビジョニ...

リクエストの処理フロー
Receive
incoming
request
• Check for item in
dedicated cache
• If found return
cached item
Check
throttling
co...

モデル
• リクエスト/レスポンスで扱われるデータのスキー
マを定義したもの
– テンプレートとマッピングして使う
– JSON形式で定義
• モデルの情報を元にSDKを生成
• API内で複数メソッドをまたがってモデルを再利用
可

モデル例：元データ
{
"department": "produce",
"categories": [
"fruit",
"vegetables"
],
"bins": [
{
"category": "fruit",
"type": "ap...

モデル例
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "GroceryStoreInputModel",
"type": "object",
"propert...

マッピングテンプレート
• あるデータを別の形式に変換することが可能
• インプットとアウトプットそれぞれのマッピングテンプレートを作
成
• マッピングテンプレートはVelocity Template Language (VTL) お
よびJ...

$変換例: JSONからXMLに API Gateway Backend GET - /peoples/1234 Lambda fn get_people /peoples/1234 { “name” : “John” } <xml> <name...$

SDKの生成

クライアントSDKの自動生成
• ステージごとに生成可能
• API設定を元に自動生成
– モデルの設定を元にIn/Outのマーシャリングに関する処理も含ま
れる
• スロットリング時のリトライやリクエストの署名
に関する処理を含む
• And...

価格
• 100万リクエストあたり$3.50
• AWS無料枠に含まれる
– 100万リクエスト/月を12ヶ月間
• 外向きデータ転送量(AWSの標準価格)
– 10TBまで$0.09/GB
– 次の40TBまで$0.085/GB
– 次の10...

価格 – キャッシュ
Cache Memory
Size (GB)
Price per Hour
(USD)
0.5 $0.020
1.6 $0.038
6 $0.200
13 $0.250
28 $0.500
58 $1.000
118 $1...

制限事項
• 利用可能なリージョン
– US East (N. Virginia)
– US West (Oregon)
– EU West (Dublin)
• アカウントあたり最大で60APIまで
• APIあたり300リソースまで
• A...

Amazon API Gateway
http://aws.amazon.com/apigateway/
Build, Deploy & Manage your APIs NOW

参考文献
• Developer Guide
http://docs.aws.amazon.com/apigateway/latest/developergu
ide/welcome.html
• AWS Lambda
http://docs....

AWS Black Belt Tech シリーズ 2015 - Amazon API Gateway