REST カテゴリ

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：17分

    • REST 呼び出しの機能を確認します。

    REST 要求の送信 - 受信 - REST API エクスプローラー

    このテスト ステップは、REST API エクスプローラーから始まります。REST API エクスプローラーを使用して、現在のインスタンスへの REST 要求の HTTP メソッド、パス、クエリー パラメーター、要求ヘッダー、本文を作成して指定します。

    要求をテストすると、[自動テストステップの作成] ボタンが表示されます。[自動テストステップの作成] をクリックしてテストステップを作成します。このボタンは、要求が送信されるまで表示されません。要求ペイロードが最大要求ペイロードサイズプロパティより大きい場合は、テスト ステップを作成できません。

    このテストステップは、REST 要求送信 - インバウンドテストステップと同じテストレコードを作成します。テストステップを作成した後は、戻って REST API エクスプローラーを使用してテストを更新することはできません。すべての変更は、REST 要求の送信 - インバウンドテストステップフォームで行う必要があります。

    このステップの一部として HTTP 応答の検証が実行されることはありません。応答ペイロードのサイズが大きすぎる場合、要求パラメーターが無効な場合、または要求を送信できなかった場合、ステップは失敗します。アサーションステップを使用して応答を検証します。

    このステップを使用して、別のインスタンスまたは第三者/リモートアドレスに要求を送信することはできません。

    これらの入力は、REST API エクスプローラー用です。表示されるフィールドは、選択した API によって異なります。インスタンスで REST API を使用する方法の詳細については、「REST API」を参照してください。

    表 : 1. 入力
    フィールド 説明
    名前空間 要求の名前空間。リストから選択します。
    API 名 使用する API。リストから選択します。
    API バージョン 使用する API バージョン。インスタンスで利用可能なバージョンをリストから選択します。
    パスパラメーター API 名の後のパスの部分。パスパラメーターは通常、許容値がリスト内にある名前と値のペアです。
    クエリパラメーター パスの後の URI に追加されるクエリパラメーターの名前と値のペア。

    REST API エクスプローラーは URI をエンコードするため、クエリのパラメーターと値をエンコードする必要はありません。
    要求ヘッダー 要求ヘッダーに含まれる名前と値のペア。現在のユーザーの認証情報を使用するには、認証ヘッダーを [自分で送信 (Send as me)] に設定します。本番環境でテストステップを使用するには、[REST を送信 - 受信 (Send REST - Inbound)] テストステップの [認証タイプ (Authentication Type)] フィールドを変更する必要が生じる場合があります。

    名前または値をエンコードしないでください。
    要求本文 要求コンテンツ。一部の要求には本文がありません。

    REST 要求の送信 - 受信

    現在のインスタンスに REST 要求を送信するテスト ステップを作成します。REST 要求の HTTP メソッド、パス、クエリー パラメーター、要求ヘッダー、および本文を指定します。

    このステップの一部として HTTP 応答の検証が実行されることはありません。応答ペイロードのサイズが大きすぎる場合、要求パラメーターが無効な場合、または要求を送信できなかった場合、ステップは失敗します。アサーションステップを使用して応答を検証します。

    このステップを使用して、別のインスタンスまたは第三者/リモートアドレスに要求を送信することはできません。

    REST API を使用する方法の詳細については、REST API を参照してください。

    表 : 2. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。
    認証タイプ

    使用する認証のタイプ。パブリック API の場合は、[なし (None)] を選択します。

    基本認証または相互認証を構成するには、ユーザーに atf_ws_designer ロールが必要です。詳細については、「自動テストフレームワーク (ATF) ロール」を参照してください。
    ベーシック認証

    テストを行うときに使用するベーシック認証プロファイル。テスト実行時の認証の問題を回避するために、テストステップに割り当てるベーシック認証プロファイルを作成または選択する必要があります。詳細については、「自動テストフレームワーク (ATF) を使用した基本認証プロファイルの作成」を参照してください。

    相互認証

    相互認証用の X.509 証明書。テスト実行時の認証の問題を回避するために、テストステップにアサインするクライアント証明書を作成または選択する必要があります。詳細については、「Set up Certificate-based authentication」を参照してください。
    メソッド 使用する HTTP メソッド：
    • GET
    • POST
    • PUT
    • DELETE
    • PATCH
    パス 使用するパス。このフィールドは、URI のインスタンス名の後の部分のみを受け入れます。https://<インスタンス名> を使用した場合、エラーが発生します。
    クエリパラメーター クエリパラメーターの名前と値。パラメーター名または値をエンコードしないでください。
    ヘッダー ヘッダーの名前と値。ヘッダー名または値をエンコードしないでください。
    本文 要求の本文。

    ステータスコードのアサート

    HTTP 応答ステータスコードが、指定された値と指定された関係にあることを確認します。ステータスコードと関係には数値を指定します。

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    表 : 3. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。
    運用 値間で実行する比較：
    • 次の値に等しい
    • ではない
    • 次の値未満 (<)
    • >
    • 次の値以下
    • 以上
    ステータスコード 応答コードに対してテストするステータスコード。

    ステータスコード名のアサート

    HTTP 応答ステータスコード名が、指定された値と指定された関係にあることを確認します。ステータスコード名と関係の値を指定します。

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    表 : 4. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。
    運用 値間で実行する比較：
    • 次の値を含む
    • 次の値を含まない
    • 次の値に等しい
    • ではない
    ステータスコード名 テストするステータスコード名。

    応答時間のアサート

    HTTP 応答応答時間が、指定された値と指定された関係にあることを確認します。応答時間と関係の値を指定します。

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    表 : 5. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。
    運用 入力された応答時間と実際の応答時間の間で実行される比較：
    • 次の値未満 (<)
    • >
    応答時間 (ミリ秒) 実際の応答時間と比較する時間 (ミリ秒)。

    応答ヘッダーのアサート

    HTTP 応答ヘッダーが存在するか、ヘッダーが指定された値と指定された関係にあることを確認します。

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    表 : 6. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。
    ヘッダー ヘッダー名。
    運用 値間で実行する比較：
    • 次の値を含む
    • 次の値を含まない
    • 次の値に等しい
    • ではない
    • は空でない
    値 テストで使用する要素値。[運用] が空でない場合は表示されません。

    応答 JSON ペイロードのアサートが有効

    応答ペイロードが有効な JSON 形式であることを確認します。

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    表 : 7. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。

    応答 XML ペイロードのアサート形式が適切

    応答のペイロードの形式が適切な XML であることを確認します

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    表 : 8. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。

    XML ペイロード要素のアサート

    XML 応答のペイロード要素が存在するか、または指定された値と指定された関係にあることを確認します。

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    表 : 9. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。
    要素パス 評価する要素への XML パス。例：/result/short_description
    {
  "result": {
    "number": "INC0020001",
    "short_description": "test"
  }
}
    運用 値間で実行する比較：
    • 次の値を含む
    • 次の値を含まない
    • 次の値に等しい
    • ではない
    • は空でない
    値 テストで使用する要素値。[運用] が空でない場合は表示されません。

    JSON 応答ペイロード要素のアサート

    JSON 応答のペイロード要素が存在するか、または指定された値と指定された関係にあることを確認します。

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    表 : 10. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。
    要素パス 評価する要素への SNC パス。例：/result/short_description
    {
  "result": {
    "number": "INC0020001",
    "short_description": "test"
  }
}
    詳細については、「JSON ファイルをインポートする」を参照してください。
    運用 値間で実行する比較：
    • 次の値を含む
    • 次の値を含まない
    • 次の値に等しい
    • ではない
    • は空でない
    値 テストで使用する要素値。[運用] が空でない場合は表示されません。

    応答ペイロードのアサート

    HTTP 応答応答ペイロードが、指定された値と指定された関係にあることを確認します。値と関係を指定します。

    アサーションステップは、[REST 要求の送信 - 受信] ステップの直後に実行される必要があります。[REST 要求の送信 - 受信] ステップに続いて複数の REST アサーションステップを実行できますが、他のテストカテゴリのステップによってアサーションステップを [REST 要求の送信 - 受信] ステップから分離することはできません。

    注:
    一致を探すためにペイロード全体が使用されます。ペイロードが大きいとパフォーマンスに影響する可能性があります。
    表 : 11. 入力
    フィールド 説明
    実行順序 テストのこのステップの実行順序を指定する整数。

    ステップを作成すると、各ステップに増分値が自動的に割り当てられます。この値により、テストでは、ステップが作成された順に実行されます。このデフォルトを変更するには、[実行命令] 値を編集します。
    有効 このテストステップの使用をアクティブ化するオプション。
    アプリケーション システムがこのステップを実行するアプリケーションスコープ。
    テスト ステップを追加するテストの読み取り専用の名前。
    ステップ構成 ステップの読み取り専用の名前。
    説明 テストステップの説明。このフィールド値はテストステップのフィールド値に基づいて自動的に設定されます。このフィールドは、テストステップが送信された後に表示されます。
    メモ テストステップに関するメモ。
    運用 値間で実行する比較：
    • 次の値を含む
    • 次の値を含まない
    • 次の値に等しい
    • ではない
    • は空でない
    応答本文 テストで使用する応答本文の値。

    応答ペイロードに表示されるときに比較される名前と値を含める必要があります。中括弧を含めることはできません。

    [運用] が空でない場合は表示されません。
    応答ペイロードの簡単な説明を確認するには
    {"result":{"number":"INC0010040","short_description":"Test ATF Incident"}}
    応答本文に以下のものが含まれなければなりません。
    "short_description":"Test ATF Incident"
    これらの形式は正しくないため、ステップは失敗します。
    • {"short_description":"ATF インシデントのテスト"}
    • "{"short_description":"ATF インシデントのテスト"}"
    • short_description: ATF インシデントのテスト
    • short_description:"ATF インシデントのテスト"