【AWS API Gateway Tips】カスタムドメインのAPIマッピング

はじめに

AWS API Gatewayで、カスタムドメインを利用している場合の、APIマッピング方法を紹介する。複数バージョンを管理する場合などに有用。

前提条件

• API Gateway
  • API構築済み
    • 本番用ステージprod構築済み
    • 開発用ステージdev構築済み
  • ドメイン取得済みで、カスタムドメイン名を設定済み

方法

APIマッピングとは、カスタムドメイン名でのアクセスにおいて、どのAPIにマッピングするかの設定である。

詳細な手順は、こちらの記事を参照。

ここでは、APIに設定したステージとのマッピングについて、上記記事からAWSでの設定UIが変更されているので解説する。

APIマッピングを設定したいカスタムドメイン名を選択し、APIマッピングの設定ページに移動する。

「APIマッピングを設定」を押して、APIマッピングを設定する。

ここでは、APIに、本番用ステージprodと開発用ステージdevが構築済みであるとする。今回は2つのAPIマッピングを設定する。カスタムドメイン名から、これらのステージにアクセスできるようにマッピング設定すると以下のように設定できる。

• API
  • カスタムドメイン名からアクセスしたい構築済みAPIを選択する
• ステージ
  • APIのステージを選択する（本番用、開発用など）
• パス（オプション）
  • カスタムドメインに続くパスを設定する

設定が完了したら「保存」ボタンを押して終了。以下のようになる。

APIへアクセスするためのアドレスは、つまりAPIエンドポイントは以下のようになる。

ステージ	パス	APIエンドポイント
prod	-	https://{your.custom.domain}/{api-name}
dev	dev	https://{your.custom.domain}/dev/{api-name}

本番用ステージprodでは、マッピングでパスを設定していないので、カスタムドメインに、REST APIで設定したAPI名がそのまま続く形となる。
一方、開発用ステージdevでは、マッピングでパスをdevに設定したので、カスタムドメインの後にdevが入り、その後に、REST APIで設定したAPI名が続く形となる。

まとめ

AWS API Gatewayで、カスタムドメインを利用している場合の、APIマッピング方法を紹介した。複数バージョンを管理する場合などに有用。

参考