メニュー
Amazon API Gateway
開発者ガイド

Amazon API Gateway で API を呼び出す

デプロイされた API を呼び出すには、API 実行の API Gateway コンポーネントサービス (execute-api) にリクエストを送信する必要があります。そのようなリクエストのルート URL は次の形式になります。

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

{restapi_id} は API ID、{region} は API がデプロイされているリージョン、{stage_name} は API デプロイのステージ名です。

このルート URL は、指定された [Stage Editor] で確認できます。上部に [Invoke URL] として表示されます。API のルートリソースでユーザー認証を必要としない GET メソッドを公開している場合、このメソッドは [Invoke URL] リンクをクリックして呼び出すことができます。このルート URL は、API の公開されている Swagger 定義ファイルの host フィールドと basePath フィールドを組み合わせて構築することもできます。

API が匿名アクセスを許可している場合は、任意のウェブブラウザでアドレスバーに適切な呼び出し URL をコピーして貼り付けることで GET メソッド呼び出すことができます。他のメソッドまたは認証が必要な呼び出しに関しては、ペイロードを指定するか、またはリクエストに署名する必要があるため、呼び出しはより複雑です。 HTML ページの裏のスクリプトで、または AWS SDK の 1 つを使用して、クライアントのアプリケーションで処理することができます。

テストについては、API Gateway コンソールを使用して、呼び出し URL をバイパスし、API がデプロイされる前に API のテストを許可する API Gateway の TestInvoke 機能を使用した API を呼び出すことができます。 または、「Postman」アプリを使用して、スクリプトまたはクライアントを記述せずに、正常にデプロイされた API をテストすることができます。

注記

呼び出し URL のクエリ文字列パラメーターの値に %% を含めることはできません。

すでに API Gateway で API をデプロイしている必要があります。API のデプロイの手順に従います。

API Gateway コンソールで、API の 呼び出し URL を取得する

  1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

  2. 呼び出す API の名前を含むボックスで、[Stages] を選択します。

  3. [Stages] ペインで、ステージの名前を選択します。

  4. [Invoke URL] の横に表示される URL は、このようになります。ここで my-api-id は、API Gateway が API に割り当てる識別子、region-id は、API をデプロイした AWS リージョンの識別子 (us-east-1 など)、stage-name は、呼び出す API のステージ名です。

    Copy
    https://my-api-id.execute-api.region-id.amazonaws.com/stage-name/{resourcePath}

呼び出すメソッドタイプと使用するツールに応じて、この URL をクリップボードにコピーしてから同 URL を貼り付け、ウェブブラウザ、ウェブデバッギングプロキシツール、cURL コマンドラインツール、または自身の API から API を呼び出すように変更します。

呼び出すメソッドまたは呼び出しに使用する形式がよくわからない場合は、メソッドのリストを表示する の手順に従い、使用可能なメソッドのリストを参照してください。

API Gateway コンソールから直接メソッドを呼び出す方法については、「コンソールを使用してメソッドをテストする」を参照してください。

他のオプションについては、API 所有者にお問い合わせください。