Amazon API Gateway での REST API の呼び出し - Amazon API Gateway

Amazon API Gateway での REST API の呼び出し

デプロイされた API を呼び出すには、API 実行の execute-api コンポーネントサービス (API Gateway と呼ばれます) の URL にクライアントがリクエストを送信します。

REST API のベース URL の形式は以下のとおりです。

https://restapi_id.execute-api.region.amazonaws.com/stage_name/

restapi_id は API ID、region は AWS リージョン、stage_name は API デプロイのステージ名です。

重要

API を呼び出す前に、API Gateway でデプロイする必要があります。API をデプロイする手順については、「Amazon API Gateway での REST API のデプロイ」を参照してください。

API の呼び出し URL の取得

API の呼び出し URL を取得するには、コンソール、AWS CLI、またはエクスポートされた OpenAPI 定義を使用できます。

コンソールを使用した API の 呼び出し URL の取得

次の手順では、REST API コンソールで API の呼び出し URL を取得する方法を示します。

REST API コンソールを使用して API の 呼び出し URL を取得するには
  1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

  2. デプロイされた API を選択します。

  3. メインのナビゲーションペインで、[ステージ] を選択します。

  4. [ステージの詳細] で、コピーアイコンを選択して API の呼び出し URL をコピーします。

    この URL は API のルートリソース用です。

    REST API を作成すると、コンソールに API の呼び出し URL が表示されます。
  5. API で別のリソース用の API の呼び出し URL を取得するには、セカンダリナビゲーションペインでステージを展開し、メソッドを選択します。

  6. コピーアイコンを選択して API のリソースレベルの呼び出し URL をコピーします。

    REST API のリソースレベルの URL は、ステージのセカンダリナビゲーションペインの下にあります。

AWS CLI を使用した API の呼び出し URL の取得

次の手順では、AWS CLI を使用して API の呼び出し URL を取得する方法を示します。

AWS CLI を使用した API の 呼び出し URL の取得
  1. rest-api-id を取得するには、次のコマンドを使用します。このコマンドは、リージョンのすべての rest-api-id 値を返します。詳細については、「get-rest-apis」を参照してください。

    aws apigateway get-rest-apis
  2. 例の 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 の呼び出し

ターミナルで curl などのツールを使用して API を呼び出すことができます。次の curl コマンドの例では、API の prod ステージの getUsers リソースで GET メソッドを呼び出します。

Linux or Macintosh
curl -X GET 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'
Windows
curl -X GET "https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers"