01 API Gateway 基本設定ガイド
[更新日：2025年2月18日]
概要
API Gatewayの基本設定手順を示します。 API Gatewayを利用するには以下の2つを作成する必要があります。
サービス
API Gatewayが管理するバックエンドサービスのエンドポイント
実際にリクエストを受けとる対象となるURLや、ホスト名、ポート番号などの情報を持つ
ルート
クライアントから送られたリクエストを適切なバックエンドサービスにルーティングする
サービス作成
サイドバーからサービス一覧を選択し、サービス作成ボタンを押下します。
バックエンドサービスの情報を入力し、作成ボタンを押下するとサービスを作成することができます。
設定値
項目 |
設定値 |
|---|---|
名前（必須） |
任意のサービス名 |
タグ |
任意の値 |
プロトコル（必須） |
http or https |
ホスト（必須） |
バックエンドサービスのホスト |
パス |
バックエンドサービスのパス（未入力の場合、「/」に設定される） |
ポート |
バックエンドサービスのポート番号（未入力の場合、設定したプロトコルに対応するポート番号が設定される） |
認証設定 |
なし |
作成に成功すると、以下のようにサービス一覧画面に表示されます。
サービス名をクリックもしくは行をダブルクリックすることで、サービス詳細画面に遷移します。
サービス詳細画面に遷移すると、登録したサービスの情報を確認することができます。
ルートの作成
サイドバーからルート一覧を選択し、ルート作成ボタンを押下します。
必要な項目を入力し、作成ボタンを押下するとルートを作成することができます。
設定値
項目 |
設定値 |
|---|---|
名前（必須） |
任意のルート名 |
タグ |
任意の値 |
プロトコル（必須） |
http or https or http/https |
パス |
任意のパス（未入力の場合、「/」が設定される） |
HTTPメソッド |
ルートへのアクセスメソッド（未入力の場合、全メソッドが許可される） |
作成に成功すると、以下のように一覧画面に表示されます。
なお、ルートのホストの値は自動で発効されます。
ルート名をクリックもしくは行をダブルクリックすることで、ルート詳細画面に遷移します。
ルート詳細画面に遷移すると、登録したルートの情報を確認することができます。
設定完了
これでAPI Gatewayの設定をすることができました。
例の場合、以下のパスでルートに設定したメソッドを使用してリクエストを行うことで、バックエンドサービスにアクセスすることが可能となります。
https://site-vktmrppn95p1ckkw.tk1.apigw.sakura.ne.jp