📌 概要
AWS API Gateway を使用して新しい API を作成する際、カスタムドメイン名(Custom Domain Name) は必須ではありません。本記事では API Gateway のデフォルトドメイン名 と カスタムドメイン名の違い、および カスタムドメイン名の設定手順 について説明します。
✅ デフォルトの設定
新しい API を作成すると、API Gateway が自動的にデフォルトのドメイン名 を生成します。形式は次のようになります:
https://{api-id}.execute-api.{region}.amazonaws.com/{stage}
例
https://abc123.execute-api.ap-northeast-1.amazonaws.com/prod
この デフォルトドメイン名 を使用して、カスタムドメイン名を設定せずに API を直接呼び出すことができます。
🛠 カスタムドメイン名を設定するべきケース
カスタムドメイン名は必須ではありませんが、以下のような場合には設定を推奨します。
-
ユーザーエクスペリエンス向上
- カスタムドメイン名(例:
https://api.example.com
)を使用することで、ブランドの一貫性を高め、ユーザーが覚えやすくなります。
- カスタムドメイン名(例:
-
SSL 証明書のバインド
- 通信を暗号化し、データの安全性を確保します。
- AWS Certificate Manager(ACM) を利用することで無料で証明書を管理できます。
-
複数の API を統合
- 同じカスタムドメイン名で複数の API を異なるパスにルーティングし、管理とアクセスを簡素化します。
📋 カスタムドメイン名の設定手順
Step 1️⃣:ACM 証明書の作成または選択
- AWS Certificate Manager(ACM) にアクセスします。
- パブリック証明書 を作成し、ドメイン所有権を確認します(DNS 検証が推奨されます)。
Step 2️⃣:カスタムドメイン名の作成
- API Gateway コンソール を開きます。
- 左側メニューから Custom Domain Names を選択します。
-
Create をクリックし、以下の情報を入力します:
-
Domain Name:カスタムドメイン名を入力します(例:
api.example.com
)。 - ACM 証明書:ACM で作成した証明書を選択します。
-
Domain Name:カスタムドメイン名を入力します(例:
Step 3️⃣:API マッピングの設定
- Custom Domain Names ページで API Mapping をクリックします。
- 使用する API とステージ(例:
prod
)を選択します。 - パスのマッピングを設定します(例:
/v1
または/
)。
Step 4️⃣:DNS レコードの更新
DNS プロバイダー(例:Route 53)にアクセスし、CNAME レコード を追加します。カスタムドメイン名を API Gateway が提供する CloudFront のドメイン名 に向けます。
⚠️ 注意点
- ACM 証明書は API Gateway と同じリージョンで作成する必要があります。
- カスタムドメイン名は現在、REST API および HTTP API のみサポートされ、WebSocket API には対応していません。
🏁 結論
- カスタムドメイン名は必須ではありませんが、デフォルトドメイン名でも基本的な API 呼び出しには対応できます。
- ただし、本番環境ではカスタムドメイン名の設定を推奨し、ユーザー体験とセキュリティの向上を図りましょう。