REST API テスト チュートリアル – サンプル マニュアル テスト ケース

替え： トーマス・ハミルトン トーマス・ハミルトン
Hours 更新中

REST APIテストとは何ですか?

REST APIのテスト は、Web アプリケーションの RESTful API をテストするために使用されるオープンソースの Web 自動テスト技術です。 残りの API テストの目的は、さまざまな HTTP/S リクエストを送信して残りの API の応答を記録し、残りの API が正常に動作しているかどうかを確認することです。 Rest API テストは、GET、POST、PUT、および DELETE メソッドによって実行されます。

残余 Representational State Transferの略。これは、開発で使用されるアーキテクチャスタイルと通信アプローチです。 ウェブサービス。 REST は、API を構築するための論理的な選択肢となっています。 これにより、ユーザーはクラウド サービスに効率的に接続して操作できるようになります。

API またはアプリケーション プログラミング インターフェイスは、Web ベースのソフトウェア アプリケーションにアクセスするための一連のプログラミング命令です。 言い換えれば、個々のプログラムが相互に直接通信し、相互の機能を使用して情報を取得するために使用される一連のコマンドです。 たとえば、Google Web サイトには、検索、翻訳、カレンダーなどのさまざまな機能のための API が含まれています。

一般的な API は以下のようなもので、サーバー名、パスなどが含まれます。

http://<server name>/v1/export/Publisher/Standard_Publisher_Report?format=csv

APIメソッドの種類

主に4種類あります APIテスト メソッド: GET、POST、削除、および PUT。

  • GET– GET メソッドは、指定された URI を使用して指定されたサーバーから情報を抽出するために使用されます。 GET リクエストの使用中は、データを抽出するだけであり、データに他の影響を与えるべきではありません。
  • POST– POST リクエストは、新しいエンティティを作成するために使用されます。 HTML フォームを使用して、顧客情報、ファイルのアップロードなどのデータをサーバーに送信するためにも使用できます。
  • PUT– 新しいエンティティを作成するか、既存のエンティティを更新します。
  • DELETE– URI で指定されたターゲット リソースの現在の表現をすべて削除します。

REST APIをテストする方法

API テストでは、アプリケーションがテスト用のサンプル API と対話する必要があります。 API をテストするには、XNUMX つのことが必要です。

  • APIを駆動するテストツール/フレームワーク
  • サンプル REST API をテストするための独自のコードを書き留める

REST API テスト ケースは、次のようなツールを使用してテストできます。

  • AdvancedRestクライアント
  • Postman-レストクライアント
  • Linux でのカール

ここでは Advanced Rest Client を使用します。Advance Rest Client を入手する手順は以下のとおりです。

Advanced Rest クライアントを入手するにはどうすればよいですか?

    • に行く Google Chromeのウェブストア
    • 「Advanced Rest Client」を検索するか、直接アクセスします。 こちら そして拡張機能をインストールします

Advance Rest クライアントのインストール方法

  • Chrome のアプリセクション (chrome://apps/) の下にある「Advanced Rest Client」アイコンを選択します。

インストールが完了したら、以下のテストに従ってください。 RESTful API

関連記事

REST APIをテストする手順

ここでは Chrome ブラウザで REST クライアント拡張機能を使用しています。 分かりやすく理解するために、テストにはダミー API を使用しています。」

http://ip.jsontest.com/

ステップ 1) アドバンスト REST クライアントを開く

アプリの Advanced REST クライアント (ARC) が正常にインストールされたら、起動します。

アドバンスト REST クライアントを開く

ステップ 2) テストする API の URL を入力します

URL テキストボックスにテスト用のサンプル REST API URL を入力します。

テストするAPIのURL

ステップ 3) HTTP メソッドを選択します

API テストでヒットする HTTP メソッドのタイプを選択します (例: POST)

HTTPメソッド

ステップ 4) ヘッダー セットを提供する

ヘッダー テキスト ボックスにヘッダー セットを入力します。ヘッダー セットの挿入をクリックします。

ヘッダーセット

ステップ5) ヘッダーの設定を確認します

次に「このセットを使用」をクリックします。

ヘッダーセット

ステップ 6) 必要な本文コンテンツを入力します

  1. 次に、「Body」タブに切り替えます。
  2. 必要な本文コンテンツ タイプとエディタ ビューを設定します。例: 本文コンテンツ タイプ: application/json
  3. エディター ビュー: 生の入力。
  4. [ペイロード] で、テスト用のデモ API のリクエスト本文をキーと値のペアの形式で渡します (例: {{"key1":"value1","key2":"value2"})。 ポスト API の場合は、本文またはパラメーターを渡す必要があります。 指定されたペイロードの下を通過します。
{"property" : ["Sites"], "report_type" : ["ALL"]}

REST APIをテストする手順

ステップ7) 詳細を送信してテストを開始します

  1. 送信ボタンを押します。
  2. 「詳細」ボタンをクリックすると、応答ヘッダーが表示されます。

REST APIをテストする手順

回答の詳細は次のとおりです。

REST APIをテストする手順

結果の検証

主にWeb APIテストでは、レスポンスコード、レスポンスメッセージ、レスポンスボディを確認する必要があります。

以下は、API テスト中に発生する可能性のあるさまざまな応答コードです。

結果の検証

REST APIテストツール

API テストの課題

REST サービスのテスト中にテスターに​​とって興味深い問題は次のとおりです。

  1. テスト ハーネスが API 呼び出しのパラメーターを変更して、機能を検証し、障害を明らかにすることを確認します。 これには、境界条件の探索と共通パラメータの割り当てが含まれます。
  2. XNUMX つ以上のパラメータを使用した呼び出しに対する興味深いパラメータ値の組み合わせの作成
  3. API 呼び出しを行う必要があるコンテンツを特定します。 これには、外部環境条件 (周辺機器、ファイルなど) や、API に影響を与える内部保存データの設定が含まれる場合があります。
  4. 関数が実行される順序に従って API 呼び出しをシーケンスする
  5. API が連続した呼び出しから有益な結果を生成できるようにするため。

製品概要

  • API またはアプリケーション プログラミング インターフェイスは、Web ベースのソフトウェア アプリケーションにアクセスするための一連のプログラミング命令です。
  • REST API 自動テストには、GET、POST、Delete、PUT など、主に 4 つのメソッドが含まれます。
  • API テストのテスト ケースでは、応答コード、応答メッセージ、応答本文を確認する必要があります。