HTTP クライアントリファレンス
client オブジェクトは、HTTP クライアントセッションのメタデータへのアクセスを提供し、HTTP レスポンスと出力内の ログ テキストを テスト で変換します。 このオブジェクトは DataGrip が起動するたびに再初期化され、DataGrip の再起動間ではデータは保持されません。
client オブジェクトは、変数ストレージとして機能するネストされた グローバルオブジェクトも公開します。
メソッド
テスト
名前が testName で本体が func のテストを作成します。 すべてのテストは、応答ハンドラースクリプトの後に実行されます。 テスト結果は、 サービス ツールウィンドウの テスト タブに表示されます。
パラメーター | タイプ | 説明 |
|---|---|---|
testName | 文字列 | テスト名 |
func | 関数 | HTTP 応答をテストする JavaScript 関数 |
assert
指定された 条件 が true であることを確認し、そうでない場合は例外をスローします。 オプションの メッセージ パラメーターは例外メッセージとして使用されます。
パラメーター | タイプ | 説明 |
|---|---|---|
条件 | boolean | レスポンスで確認する条件 |
メッセージ | 文字列 | 条件が false と評価された場合に返されるオプションのメッセージ。 |
ログ
応答ハンドラーまたは事前要求スクリプトの出力に text を出力し、行を終了します。
パラメーター | タイプ | 説明 |
|---|---|---|
text | 文字列 | 応答ハンドラーまたは事前要求スクリプトの出力に出力されるテキスト。 |
終了
応答ハンドラースクリプトの実行を終了します。
プロパティ
global
グローバル変数およびヘッダーの設定および削除に使用される グローバル変数ストレージ です。
グローバル変数 (client.global.set(VariableName, VariableValue)) に値を割り当てると、後続の HTTP 要求で {{VariableName}} として、または応答ハンドラースクリプトと事前要求スクリプトで client.global.get("VariableName") を使用して、その値にアクセスできます。 詳細な例については、 グローバル変数を使用する を参照してください。
グローバル変数とヘッダー
global オブジェクトを使用すると、次のことが可能になります。
グローバル変数を設定および取得します。
グローバルヘッダーを設定します。
グローバルヘッダーを使用すると、複数の HTTP リクエストで同じヘッダーが繰り返し初期化されるのを防ぐことができます。 一度設定すると、同じ実行フロー内の後続のすべてのリクエストに暗黙的に適用されます。
グローバルヘッダーは永続的な状態を保存することを目的としたものではありません。 単一の実行フローに限定され、ヘッダーの再利用を簡素化するように設計されています。
セット
変数を varName という名前でストレージに保存し、その値を varValue に設定します。 詳細な例については、 グローバル変数を使用する を参照してください。
パラメーター | タイプ | 説明 |
|---|---|---|
varName | 文字列 | グローバルストレージに保存される変数の名前。 |
varValue | 文字列 | グローバルストレージに保存される変数値。 |
取得
varName 変数の値を返します。
パラメーター | タイプ | 説明 |
|---|---|---|
varName | 文字列 | 返される変数の名前。 |
isEmpty
global オブジェクトに変数が定義されていないかどうかを確認します。
クリア
変数ストレージから varName 変数を削除します。
パラメーター | タイプ | 説明 |
|---|---|---|
varName | 文字列 | 削除する変数の名前。 |
すべてクリア
変数ストレージからすべての変数を削除します。
headers.set
client.global.headers.set(headerName, headerValue) を使用して、 headerValue に headerName ヘッダーを追加します。 例：
レスポンスハンドラースクリプトで使用する場合、ヘッダーは後続のすべての HTTP リクエストに適用されます。 プリリクエストスクリプトで使用する場合、ヘッダーは現在の HTTP リクエストと後続のすべてのリクエストに適用されます。
パラメーター | タイプ | 説明 |
|---|---|---|
headerName | 文字列 | HTTP リクエストで使用されるヘッダーの名前。 |
headerValue | 文字列 | ヘッダーの値。 |
ヘッダーを削除するには、値として null を使用します。