API Gateway で REST API を呼び出す
デプロイされた API を呼び出すには、API 実行の execute-api コンポーネントサービス (API Gateway と呼ばれます) の URL にクライアントがリクエストを送信します。
REST API のベース URL の形式は以下のとおりです。
https://api-id.execute-api.region.amazonaws.com/stage/
api_id は API ID、region は AWS リージョン、stage は API デプロイのステージ名です。
重要
API を呼び出す前に、API Gateway でデプロイする必要があります。API をデプロイする手順については、「API Gateway で REST API をデプロイする」を参照してください。
トピック
- API の呼び出し URL の取得
- API の呼び出し
- API Gateway コンソールを使用して REST API メソッドをテストする
- REST API 用に API Gateway で生成された Java SDK を使用する
- REST API 用に API Gateway で生成された Android SDK を使用する
- REST API 用に API Gateway で生成された JavaScript SDK を使用する
- API Gateway によって生成された Ruby SDK を REST API で使用する
- Objective-C または Swift で REST API 用に API Gateway で生成された iOS SDK を使用する
API の呼び出し URL の取得
API の呼び出し URL を取得するには、コンソール、AWS CLI、またはエクスポートされた OpenAPI 定義を使用できます。
コンソールを使用した API の 呼び出し URL の取得
次の手順では、REST API コンソールで API の呼び出し URL を取得する方法を示します。
REST API コンソールを使用して API の 呼び出し URL を取得するには
https://console.aws.amazon.com/apigateway
で API Gateway コンソールにサインインします。 デプロイされた API を選択します。
-
メインのナビゲーションペインで、[ステージ] を選択します。
-
[ステージの詳細] で、コピーアイコンを選択して API の呼び出し URL をコピーします。
この URL は API のルートリソース用です。
API で別のリソース用の API の呼び出し URL を取得するには、セカンダリナビゲーションペインでステージを展開し、メソッドを選択します。
コピーアイコンを選択して API のリソースレベルの呼び出し URL をコピーします。
AWS CLI を使用した API の呼び出し URL の取得
次の手順では、AWS CLI を使用して API の呼び出し URL を取得する方法を示します。
AWS CLI を使用した API の 呼び出し URL の取得
rest-api-idを取得するには、次のコマンドを使用します。このコマンドは、リージョンのすべてのrest-api-id値を返します。詳細については、「get-rest-apis」を参照してください。aws apigateway get-rest-apis例の
rest-api-idを独自のrest-api-id、例の{stage-name}を独自の{stage-name}、{region}を独自のリージョンに置き換えます。https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
API のエクスポートされた OpenAPI 定義ファイルを使用した API の呼び出し URL の取得
API のエクスポートされた OpenAPI 定義ファイルの host フィールドと basePath フィールドを組み合わせてルート URL を構築することもできます。API のエクスポート方法の手順については、「API Gateway から REST API をエクスポートする」を参照してください。
API の呼び出し
デプロイした API は、ブラウザ、curl、または他のアプリケーション (Postman
さらに、API Gateway コンソールを使用して API コールをテストすることもできます。テストでは API Gateway の TestInvoke 機能を使用します。これにより、API をデプロイする前に API をテストできます。詳細については、「API Gateway コンソールを使用して REST API メソッドをテストする」を参照してください。
注記
呼び出し URL のクエリ文字列パラメーターの値に %% を含めることはできません。
ウェブブラウザを使用した API の呼び出し
API が匿名アクセスを許可する場合は、任意のウェブブラウザを使用して GET メソッドを呼び出すことができます。ブラウザのアドレスバーに完全な呼び出し URL を入力します。
他のメソッドや認証が必要な呼び出しについては、ペイロードを指定するか、リクエストに署名する必要があります。HTML ページの裏のスクリプトで、または AWS SDK の 1 つを使用して、クライアントのアプリケーションで処理することができます。
curl を使用した API の呼び出し
ターミナルで curlprod ステージの getUsers リソースで GET メソッドを呼び出します。
