REST Web API へのリクエストの送信方法
要求の種類
REST Web API テストでは、テストの目的に従って使用できるさまざまな HTTP メソッドがサポートされています。 GET 要求を選択すると、Web API からデータを取得するだけです。 要求パラメーターは URL に含めることができますが、専用のメソッドを使用してペイロードを API にプッシュすることをお勧めします。
カスタム情報の送信、変更データの送信、フローやイベントのトリガーを行う場合は、POST、PUT、PATCH などのリクエストタイプを使用します。 この場合、要求本文を指定するには 、[Post Data] セクションに移動します。
要求の種類を POST、PUT、または PATCH に設定し 、[Post Data] セクションで要求パラメータを指定しない場合、タスクを保存すると要求タイプは GET に戻ります。
認証
API で認証が必要な場合は、[ 基本認証 ] セクションで資格情報を指定します。 トークンベース認証が使用される方法である場合は 、OAuth 2.0 ベースの API に関する推奨事項に従い、同様の方法で認証パラメーターを構成します。
データの投稿
このセクションでは 、JSONなどの任意の要求エンティティを簡単に指定できます。
リクエスト本文を指定するには、JSON コンテンツをフィールドに貼り付けるか入力するだけです。 システムは自動的にコードを解析し、要求本文の種類に基づいてコンテンツ タイプ ヘッダーを選択するように求められます。また、必要に応じてカスタムのコンテンツタイプヘッダーを指定することもできます。
指定すると、コンテンツ タイプは自動的に [ヘッダー] セクションに追加されます。
要求のコレクションの作成
テスト内で必要な数の要求を送信できます。 すべての要求は、実行する必要がある順序でテストに追加する必要があることに注意してください。
複数要求テストを設定するには
- 最初に、新しい Rest Web API テストを作成して保存します。
- テスト内の要求のシーケンスを設定するには、テストの一覧の テストのアクション メニューから [
ターゲットの 追加] を選択します。 - 要求の設定を設定し、変更を保存します。 リクエストは、デバイス編集画面のサイドバーに、実行される順序でリストされます。 リクエストパラメータにアクセスするには、サイドバーで対応する項目を選択します。
- デバイスの編集インターフェイス内から次のリクエストを追加するには、サイドバーの「プラス」ボタンをクリックします。
マルチターゲット デバイスの構成と監視の詳細については、「 単一デバイス内での複数のターゲットの追加」を参照してください。
結果の検証
一般に、API を呼び出すだけでは不十分です。 API 応答を検証するには、応答に正確に一致するキーワードを見つけると十分です。 API レスポンスコンテンツを知ることで、[ コンテンツの検証 ] セクションにキーワードを入力できます。 詳細については、 キーワード 記事を参照してください。
ユースケース
例として、メール REST API を考えてみましょう。 サービスを監視するには、要求本文の電子メールの詳細と共に、対応する API エンドポイントに POST 要求を送信する必要があります。 これを行うには、エンドポイント URL を指定し 、POST 要求の種類を選択する必要があります。
メール REST API には基本認証が必要なので、対応するセクションで資格情報も指定する必要があります。
Post Data セクションでは、JSON 配列を電子メールの詳細で指定し、ペイロードを API エンドポイントにプッシュするヘッダーの種類を選択します。
次の手順では、検証のために API レスポンスで検索するキーワードを指定します。
-
REST API モニタリング
最近の Web アプリケーションの大半は、REST API を使用してサーバーと通信し、相互に統合します。 API でデータの品質を適切に確保するため、それを使用する Web サービス全体の品質を保証します。
Web サービス用に RESTful API を作成し、すべての API 関数が正しく動作し、24 時間 365 日使用可能であることを制御する必要があるとします。 しかし、なぜWEB APIをテストする必要があるのでしょうか? API のテストと監視の最も一般的な利点について説明します。
REST API テストの最初の利点は、問題の特定の原因を特定するうえで役立つ点です。 API をテストすることで、エラーで実行される特定の関数を見つけることができます。
また、API テストでは、Web サービスの機能をテストするための専用のテスト環境を構築する必要はありません。 Web サーバーに要求を送信するためにブラウザー ウィンドウでユーザーアクションのチェーンを必要とする UI テストとは異なって、API のテストと監視は、特定のエンドポイント要求を送信する自動化ツールを使用して実行できます。 たとえば、この方法では、GUI レベルで誤ったテストの失敗が発生するなどの問題を回避できます。
すべての API 関数を手動でテストできますが、難しく時間のかかるプロセスです。 さらに、API に変更を加えたり、API に新機能を追加するたびに、更新が API 機能に影響を与えていないことを確認するために、テストを再度実行する必要があります。 自動 REST API 監視機能を使用すると、手動テストの欠点を回避でき、API 監視ルーチンを次のレベルに引き上げることもできます。
ドットコムモニターによる REST API モニタリング
ドットコムモニターは、自動化されたAPIパフォーマンス監視のための2つのオプションを提供しています。
- REST Web API 監視デバイス。
- 郵便配達員コレクション監視装置。
RESTful API モニタリング テストをゼロから設定するには、REST Web API 監視デバイスを使用することをお勧めします。 このタイプの監視デバイスでは、基本認証および POST パラメーターを使用して、API エンドポイントへの単純な HTTP 要求を構成できます。
既に POSTman を使用して RESTful API サービスのテストを実行している場合は 、Postman コレクションを Dotcom-Monitor にインポートすることをお勧めします。 Postman リクエストのコレクションがシステムにインポートされると 、POSTman コレクション監視デバイスを 構成して、API サービスの監視を自動化できます。
REST Web API デバイスは複数の要求の実行をサポートしていますが、場合によっては構成が難しい場合があります。 このツールに慣れている場合は、REST Web API 監視用のパラメータ化された HTTP 要求とアサーション テストを構成するのに適しています。
したがって、API 呼び出しの複雑なシーケンスを使用してテストを作成する場合や、基本認証以外の認証が必要な場合は、Postman を使用して API 呼び出しのコレクションを作成します。 次に、単に、ドットコム モニター Postman コレクション デバイスにインポートし、Dotcom モニター API を 使用した Postman 監視 (収集タスク)の説明に従って監視を設定します。 Dotcom-Monitor は、指定された頻度 (最大 1 分) で API 呼び出しを実行し、レポートを生成し、指定されたアドレスに監視エラー通知を送信します。
ウェブアプリケーションとサービスの信頼性を確保するために、Dotcom-Monitorで API監視ツールの完全なスイート をチェックしてください!