Amazon API Gateway
開発者ガイド

Amazon API Gateway で REST API を呼び出す

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

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

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

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

重要

API を呼び出す前に、API Gateway でデプロイする必要があります。これを行うには、「Amazon API Gateway での REST API のデプロイ」の手順に従います。

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

REST API のルート URL は、API Gateway コンソールで、API の [ステージエディター] から見つかります。上部に [呼び出し URL] として表示されます。API のルートリソースでユーザー認証を必要としない GET メソッドを公開している場合、このメソッドは [呼び出し URL] リンクをクリックして呼び出すことができます。このルート URL は、API の公開されている OpenAPI 定義ファイルの host フィールドと basePath フィールドを組み合わせて構築することもできます。

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

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

注記

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