REST API テストの作成

REST API テストを作成し、GET、POST、PUT、および DELETE などの HTTP メソッドを使用して、Web アプリケーションの応答時間と可用性をテストします。

このタスクについて

REST API テストを使用して、REST 呼び出しへの応答で、Web アプリケーションとその他の URL の可用性とパフォーマンスをモニターします。

手順

REST API テストを作成するには、以下のようにします。

  1. アプリケーションの Availability Monitoring 要約ページを表示している場合は、「新規テストの追加 (Add New Test)」をクリックします。
    アプリケーションの Availability Monitoring 要約ページ。
    Availability Monitoring ダッシュボードを表示している場合は、「シンセティック・テスト」ペインで「新規テストの追加」をクリックします。

    「シンセティック・テスト」ペインの「新規テストの追加 (Add New Test)」ボタン。

  2. 「モニターのセットアップ」ページの「単一アクション」をクリックし、「単一アクション」ページの「REST API」をクリックします。
  3. 「名前」フィールドに、テストのわかりやすい名前を入力します。「説明」フィールドに、テストの目的の説明を追加します。
  4. 「要求」セクションで、「メソッド」リストからメソッドのタイプを選択し、そのメソッドでテストする URL を入力します。
    「GET」「PUT」「POST」、または「DELETE」を選択できます。「PUT」または「POST」メソッドを選択する場合、「要求本文 (オプション)」フィールドにテストする本文コンテンツを入力できます。

    例えば、以下の REST API テストでは POST メソッドを使用して、Web アプリケーションでデータを受け入れ、さらにその Web アプリケーションの可用性とパフォーマンスをテストするように要求します。

    POST 要求メソッドを使用する REST API テストの例。

  5. オプション: 特定のヘッダーと値が含まれるように、テストを構成します。「ヘッダー」フィールドに、ヘッダーの名前とヘッダーの値を入力します。

    テストする Web アプリケーションでユーザーのログインとパスワードが必要な場合、「ヘッダー名」フィールドに "Authorization" と入力します。「Basic」という単語、スペース文字、および username:password の base64 エンコード値を「ヘッダー値」フィールドに入力します。

    例えば、ユーザー名が Aladdin であり、パスワードが OpenSesame の場合、「Basic」という単語、スペース文字、および Aladdin:OpenSesame の base64 エンコード値を「ヘッダー値」フィールドに入力します。

    base64 でのテスト許可資格情報を示している「ヘッダー」フィールド。

  6. 「応答検証」セクションでテストの警告アラートおよびクリティカル・アラートのしきい値を構成します。各行の「値」「単位」を編集します。
    警告しきい値およびクリティカルしきい値を応答時間が超過すると、アラートがトリガーされます。

    デフォルトの警告しきい値およびクリティカルしきい値が示されている「応答検証」セクション。

  7. オプション: 「条件の追加」をクリックして、カスタマイズされた応答検証条件を定義および追加します。
    カスタマイズされた応答検証条件は集約して評価され、アラートが生成されます。テストに対して、最大で 6 つのカスタマイズされた条件を定義して追加できます。
    重要:

    Availability Monitoring では、各テストによって合計で最大 3 つのアラートを生成できます。アラートを出す条件がすべて解決されるまで、最高の重大度を持つアラートがテストで報告されます。詳しくは、Availability Monitoring でのアラート生成を参照してください。

    次のデータを検証できます。
    ヘッダーの応答コード
    「ヘッダーの応答コード」を選択し、1 つまたは特定の範囲の HTTP 応答コードをテストします。
    ヘッダーのプロパティー
    「ヘッダーのプロパティー」を選択し、特定の HTTP ヘッダー・フィールドのプロパティーと値をテストします。
    本文 JSON
    「本文 JSON」を選択して、JSON 本文の特定のプロパティーをテストします。

    条件ごとに、「ターゲット」フィールドにテストするプロパティーを入力し、「値」フィールドにテストする値を入力します。「操作」ドロップダウン・メニューから、演算子を選択します。最後に、条件に対する警告またはクリティカルの「アラートの重大度」を選択します。

    重要:

    「値」フィールドに入力した数値は、デフォルトでストリングではなく数値として扱われます。応答検証条件の「値」を入力する場合、引用符 () を使用してストリングと数字を区別してください。例えば、ストリング 123 に対してテストする場合、「値」フィールドに "123" と入力します。数字 400 に対してチェックするには、引用符を使用せずに 400 と入力します。

    ヘッダー応答コード、ヘッダー・プロパティー、および本文 JSON 用のカスタマイズされた応答検証条件。

  8. 「検証」をクリックして REST API テストを作成し、テスト要求が有効かどうかを判別します。

    Availability Monitoring は、選択した HTTP メソッドと、テスト用に定義したすべての要求ヘッダーを使用してテストの有効性を判別します。テスト検証中は、応答検証は行われません。

    検証済みのテストは、「検証済みの項目」表に表示されます。ステップ 3 から 8 を繰り返して、さらに URL を追加できます。

  9. テスト設定を構成するには、「次へ」をクリックします。

    テスト構成の要約が表示されます。デフォルト設定では、次のメッセージが表示されます。

    次のテストが実行されます: 15 分ごとに、同時に 3 箇所のパブリック・ロケーションおよび 0 箇所のプライベート・ロケーションから、テストが指定したしきい値を超過するかどうかが判別されます。

  10. 「設定」ペインで、「編集」をクリックしてテストの現在の設定を表示します。
    以下の設定を更新できます。
    • 「間隔」は、テストの実行頻度を定義します。
    • 「テスト頻度 (Testing frequency)」は、テストをすべての場所から同時に実行するか、または間隔ごとに異なる場所から実行するかを決定します。「同時」を選択すると、すべての場所から同時にテストが実行されます。「ずらし」を選択すると、間隔ごとに、選択した異なる場所からテストが実行されます。
    • 「ロケーション」は、テストを実行するロケーションを決定します。
  11. 「パブリック・ロケーション」のリストからロケーションを選択します。テストの実行元のプライベート・ロケーションを選択するには、テストの実行元のマシンに予めプライベート PoP をインストールして構成しておく必要があります。詳しくは、プライベート PoP ロケーションのインストールおよび構成を参照してください。
  12. 「保存」をクリックしてテストの構成を完了します。次に、「完了」をクリックします。
    Availability Monitoring ダッシュボードが表示されます。しばらくすると、ダッシュボードに新しいテストの情報とデータが表示されます。