API Gateway コンソールを使用して REST API メソッドをテストする - Amazon API Gateway

API Gateway コンソールを使用して REST API メソッドをテストする

API Gateway コンソールを使用して REST API メソッドをテストします。

Prerequisites

API Gateway コンソールを使用してメソッドをテストする

重要

API Gateway コンソールでメソッドをテストすると、リソースが変更され、元に戻せなくなる場合があります。API Gateway コンソールでメソッドをテストすることは、API Gateway コンソール外でメソッドを呼び出すことと同じです。たとえば、API Gateway コンソールを使用して API リソースを削除するメソッドを呼び出した場合、メソッドの呼び出しが成功すると、API のリソースは削除されます。

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

  2. REST API を選択します。

  3. [リソース] ペインで、テストするメソッドを選択します。

  4. [メソッドの実行] ペインの [クライアント] ボックスで、[テスト] を選択します。表示されたいずれかのボックスに値を入力します ([クエリ文字列]、[ヘッダー]、[リクエストボディ] など)。コンソールには、メソッドリクエストにこれらの値がデフォルトの application/json 形式で含まれています。

    指定する必要がある追加オプションについては、API 所有者までお問い合わせください。

  5. [Test (テスト)] を選択します。次の情報が表示されます。

    • [リクエスト]: メソッド用に呼び出されたリソースのパスです。

    • [ステータス]: 応答の HTTP ステータスコードです。

    • [レイテンシー]: 発信者からリクエストを受信してから応答を返すまでの時間です。

    • [レスポンス本文]: HTTP 応答の本文です。

    • [レスポンス本文]: HTTP 応答のヘッダーです。

      ヒント

      マッピングによっては、HTTP ステータスコード、レスポンス本文、レスポンスヘッダーが、Lambda 関数、HTTP プロキシ、または AWS のサービスプロキシから送信されたものと異なる場合があります。

    • [ログ] はシミュレートされた Amazon CloudWatch Logs エントリで、このメソッドが API Gateway コンソール外で呼び出された場合は書き込まれています。

      注記

      CloudWatch Logs エントリはシミュレートされていますが、メソッドの呼び出しの結果は現実のものです。

API Gateway コンソールの使用に加えて、AWS CLI、または API Gateway 用の AWS SDK を使用してメソッドの呼び出しをテストすることもできます。AWS CLI を使用してこれを行う方法については、「test-invoke-method」を参照してください。