APIRequestContext

このAPIは、Web APIテストに使用されます。APIエンドポイントをトリガーしたり、マイクロサービスを構成したり、e2eテストの環境またはサービスを準備するために使用できます。

各Playwrightブラウザコンテキストには、それに関連付けられたAPIRequestContextインスタンスがあり、ブラウザコンテキストとクッキーストレージを共有し、browserContext.requestまたはpage.requestを介してアクセスできます。また、apiRequest.newContext()を呼び出すことで、新しいAPIRequestContextインスタンスを手動で作成することもできます。

Cookie管理

APIRequestContextは、browserContext.requestおよびpage.requestによって返され、対応するBrowserContextとクッキーストレージを共有します。各APIリクエストには、ブラウザコンテキストの値が設定されたCookieヘッダーが含まれます。APIレスポンスにSet-Cookieヘッダーが含まれている場合、BrowserContextクッキーが自動的に更新され、ページから行われたリクエストはそれらを拾い上げます。これは、このAPIを使用してログインすると、e2eテストがログインされ、逆もまた同様であることを意味します。

APIリクエストがブラウザのCookieに干渉しないようにするには、APIRequestContextをapiRequest.newContext()を呼び出して新しく作成する必要があります。このようなAPIRequestContextオブジェクトは、独自の独立したクッキーストレージを持ちます。

メソッド

delete

追加: v1.16

apiRequestContext.delete

HTTP(S) DELETEリクエストを送信し、そのレスポンスを返します。このメソッドは、コンテキストからリクエストCookieを設定し、レスポンスからコンテキストCookieを更新します。このメソッドは、自動的にリダイレクトに従います。

使用法

await apiRequestContext.delete(url);
await apiRequestContext.delete(url, options);

引数

url string #

ターゲットURL。
options Object (オプション)
- data string | Buffer | Serializable (オプション)追加: v1.17#
  
  リクエストのポストデータを設定できます。dataパラメータがオブジェクトの場合、json文字列にシリアライズされ、content-typeヘッダーが明示的に設定されていない場合はapplication/jsonに設定されます。それ以外の場合、content-typeヘッダーは明示的に設定されていない場合はapplication/octet-streamに設定されます。
- failOnStatusCode boolean (オプション)#
  
  2xxおよび3xx以外のレスポンスコードでエラーをスローするかどうか。デフォルトでは、すべてのステータスコードに対してレスポンスオブジェクトが返されます。
- form Object<string, string | number | boolean> | FormData (オプション)追加: v1.17#
  
  application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りapplication/x-www-form-urlencodedに設定されます。
- headers Object<string, string> (オプション)#
  
  HTTPヘッダーを設定できます。これらのヘッダーは、フェッチされたリクエストと、それによって開始されたリダイレクトにも適用されます。
- ignoreHTTPSErrors boolean (オプション)#
  
  ネットワークリクエストを送信するときにHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- maxRedirects number (オプション)追加: v1.26#
  
  自動的に追跡されるリクエストリダイレクトの最大数。数を超えるとエラーがスローされます。デフォルトは20です。リダイレクトを追跡しない場合は0を渡します。
- maxRetries number (オプション)追加: v1.46#
  
  ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTPレスポンスコードに基づいて再試行しません。制限を超えるとエラーがスローされます。デフォルトは0 - 再試行なし。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (オプション)追加: v1.17#
  - name string
    
    ファイル名
  - mimeType string
    
    ファイルタイプ
  - buffer Buffer
    
    ファイルコンテンツ
  multipart/form-dataエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りmultipart/form-dataに設定されます。ファイルの値は、fs.ReadStreamまたはファイル名、mime-type、およびそのコンテンツを含むファイルライクオブジェクトとして渡すことができます。
- params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#
  
  URLとともに送信されるクエリパラメータ。
- timeout number (オプション)#
  
  リクエストタイムアウト（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。

戻り値

Promise<APIResponse>#

dispose

追加: v1.16

apiRequestContext.dispose

apiRequestContext.get()および同様のメソッドによって返されるすべてのレスポンスはメモリに保存されるため、後でapiResponse.body()を呼び出すことができます。このメソッドは、すべてのリソースを破棄し、破棄されたAPIRequestContextでメソッドを呼び出すと例外がスローされます。

使用法

await apiRequestContext.dispose();
await apiRequestContext.dispose(options);

引数

options Object (オプション)
- reason string (オプション)追加: v1.45#
  
  コンテキストの破棄によって中断された操作に報告される理由。

戻り値

Promise<void>#

fetch

追加: v1.16

apiRequestContext.fetch

HTTP(S)リクエストを送信し、そのレスポンスを返します。このメソッドは、コンテキストからリクエストCookieを設定し、レスポンスからコンテキストCookieを更新します。このメソッドは、自動的にリダイレクトに従います。

使用法

JSONオブジェクトは、リクエストに直接渡すことができます

await request.fetch('https://example.com/api/createBook', {
  method: 'post',
  data: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

リクエストのボディでファイル（複数可）を送信する一般的な方法は、multipartパラメータを指定して、multipart/form-dataエンコーディングでフォームフィールドとしてアップロードすることです

const form = new FormData();
form.set('name', 'John');
form.append('name', 'Doe');
// Send two file fields with the same name.
form.append('file', new File(['console.log(2024);'], 'f1.js', { type: 'text/javascript' }));
form.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
await request.fetch('https://example.com/api/uploadForm', {
  multipart: form
});

引数

urlOrRequest string | Request #

すべてのパラメータを取得するターゲットURLまたはリクエスト。
options Object (オプション)
- data string | Buffer | Serializable (オプション)#
  
  リクエストのポストデータを設定できます。dataパラメータがオブジェクトの場合、json文字列にシリアライズされ、content-typeヘッダーが明示的に設定されていない場合はapplication/jsonに設定されます。それ以外の場合、content-typeヘッダーは明示的に設定されていない場合はapplication/octet-streamに設定されます。
- failOnStatusCode boolean (オプション)#
  
  2xxおよび3xx以外のレスポンスコードでエラーをスローするかどうか。デフォルトでは、すべてのステータスコードに対してレスポンスオブジェクトが返されます。
- form Object<string, string | number | boolean> | FormData (オプション)#
  
  application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りapplication/x-www-form-urlencodedに設定されます。
- headers Object<string, string> (オプション)#
  
  HTTPヘッダーを設定できます。これらのヘッダーは、フェッチされたリクエストと、それによって開始されたリダイレクトにも適用されます。
- ignoreHTTPSErrors boolean (オプション)#
  
  ネットワークリクエストを送信するときにHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- maxRedirects number (オプション)追加: v1.26#
  
  自動的に追跡されるリクエストリダイレクトの最大数。数を超えるとエラーがスローされます。デフォルトは20です。リダイレクトを追跡しない場合は0を渡します。
- maxRetries number (オプション)追加: v1.46#
  
  ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTPレスポンスコードに基づいて再試行しません。制限を超えるとエラーがスローされます。デフォルトは0 - 再試行なし。
- method string (オプション)#
  
  設定されている場合、フェッチメソッドを変更します（例：PUTまたはPOST）。指定しない場合、GETメソッドが使用されます。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (オプション)#
  - name string
    
    ファイル名
  - mimeType string
    
    ファイルタイプ
  - buffer Buffer
    
    ファイルコンテンツ
  multipart/form-dataエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りmultipart/form-dataに設定されます。ファイルの値は、fs.ReadStreamまたはファイル名、mime-type、およびそのコンテンツを含むファイルライクオブジェクトとして渡すことができます。
- params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#
  
  URLとともに送信されるクエリパラメータ。
- timeout number (オプション)#
  
  リクエストタイムアウト（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。

戻り値

Promise<APIResponse>#

get

追加: v1.16

apiRequestContext.get

HTTP(S) GETリクエストを送信し、そのレスポンスを返します。このメソッドは、コンテキストからリクエストCookieを設定し、レスポンスからコンテキストCookieを更新します。このメソッドは、自動的にリダイレクトに従います。

使用法

リクエストパラメータはparamsオプションで構成でき、URL検索パラメータにシリアライズされます

// Passing params as object
await request.get('https://example.com/api/getText', {
  params: {
    'isbn': '1234',
    'page': 23,
  }
});

// Passing params as URLSearchParams
const searchParams = new URLSearchParams();
searchParams.set('isbn', '1234');
searchParams.append('page', 23);
searchParams.append('page', 24);
await request.get('https://example.com/api/getText', { params: searchParams });

// Passing params as string
const queryString = 'isbn=1234&page=23&page=24';
await request.get('https://example.com/api/getText', { params: queryString });

引数

url string #

ターゲットURL。
options Object (オプション)
- data string | Buffer | Serializable (オプション)追加: v1.26#
  
  リクエストのポストデータを設定できます。dataパラメータがオブジェクトの場合、json文字列にシリアライズされ、content-typeヘッダーが明示的に設定されていない場合はapplication/jsonに設定されます。それ以外の場合、content-typeヘッダーは明示的に設定されていない場合はapplication/octet-streamに設定されます。
- failOnStatusCode boolean (オプション)#
  
  2xxおよび3xx以外のレスポンスコードでエラーをスローするかどうか。デフォルトでは、すべてのステータスコードに対してレスポンスオブジェクトが返されます。
- form Object<string, string | number | boolean> | FormData (オプション)追加: v1.26#
  
  application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りapplication/x-www-form-urlencodedに設定されます。
- headers Object<string, string> (オプション)#
  
  HTTPヘッダーを設定できます。これらのヘッダーは、フェッチされたリクエストと、それによって開始されたリダイレクトにも適用されます。
- ignoreHTTPSErrors boolean (オプション)#
  
  ネットワークリクエストを送信するときにHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- maxRedirects number (オプション)追加: v1.26#
  
  自動的に追跡されるリクエストリダイレクトの最大数。数を超えるとエラーがスローされます。デフォルトは20です。リダイレクトを追跡しない場合は0を渡します。
- maxRetries number (オプション)追加: v1.46#
  
  ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTPレスポンスコードに基づいて再試行しません。制限を超えるとエラーがスローされます。デフォルトは0 - 再試行なし。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (オプション)追加: v1.26#
  - name string
    
    ファイル名
  - mimeType string
    
    ファイルタイプ
  - buffer Buffer
    
    ファイルコンテンツ
  multipart/form-dataエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りmultipart/form-dataに設定されます。ファイルの値は、fs.ReadStreamまたはファイル名、mime-type、およびそのコンテンツを含むファイルライクオブジェクトとして渡すことができます。
- params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#
  
  URLとともに送信されるクエリパラメータ。
- timeout number (オプション)#
  
  リクエストタイムアウト（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。

戻り値

Promise<APIResponse>#

head

追加: v1.16

apiRequestContext.head

HTTP(S) HEADリクエストを送信し、そのレスポンスを返します。このメソッドは、コンテキストからリクエストCookieを設定し、レスポンスからコンテキストCookieを更新します。このメソッドは、自動的にリダイレクトに従います。

使用法

await apiRequestContext.head(url);
await apiRequestContext.head(url, options);

引数

url string #

ターゲットURL。
options Object (オプション)
- data string | Buffer | Serializable (オプション)追加: v1.26#
  
  リクエストのポストデータを設定できます。dataパラメータがオブジェクトの場合、json文字列にシリアライズされ、content-typeヘッダーが明示的に設定されていない場合はapplication/jsonに設定されます。それ以外の場合、content-typeヘッダーは明示的に設定されていない場合はapplication/octet-streamに設定されます。
- failOnStatusCode boolean (オプション)#
  
  2xxおよび3xx以外のレスポンスコードでエラーをスローするかどうか。デフォルトでは、すべてのステータスコードに対してレスポンスオブジェクトが返されます。
- form Object<string, string | number | boolean> | FormData (オプション)追加: v1.26#
  
  application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りapplication/x-www-form-urlencodedに設定されます。
- headers Object<string, string> (オプション)#
  
  HTTPヘッダーを設定できます。これらのヘッダーは、フェッチされたリクエストと、それによって開始されたリダイレクトにも適用されます。
- ignoreHTTPSErrors boolean (オプション)#
  
  ネットワークリクエストを送信するときにHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- maxRedirects number (オプション)追加: v1.26#
  
  自動的に追跡されるリクエストリダイレクトの最大数。数を超えるとエラーがスローされます。デフォルトは20です。リダイレクトを追跡しない場合は0を渡します。
- maxRetries number (オプション)追加: v1.46#
  
  ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTPレスポンスコードに基づいて再試行しません。制限を超えるとエラーがスローされます。デフォルトは0 - 再試行なし。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (オプション)追加: v1.26#
  - name string
    
    ファイル名
  - mimeType string
    
    ファイルタイプ
  - buffer Buffer
    
    ファイルコンテンツ
  multipart/form-dataエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りmultipart/form-dataに設定されます。ファイルの値は、fs.ReadStreamまたはファイル名、mime-type、およびそのコンテンツを含むファイルライクオブジェクトとして渡すことができます。
- params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#
  
  URLとともに送信されるクエリパラメータ。
- timeout number (オプション)#
  
  リクエストタイムアウト（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。

戻り値

Promise<APIResponse>#

patch

追加: v1.16

apiRequestContext.patch

HTTP(S) PATCHリクエストを送信し、そのレスポンスを返します。このメソッドは、コンテキストからリクエストCookieを設定し、レスポンスからコンテキストCookieを更新します。このメソッドは、自動的にリダイレクトに従います。

使用法

await apiRequestContext.patch(url);
await apiRequestContext.patch(url, options);

引数

url string #

ターゲットURL。
options Object (オプション)
- data string | Buffer | Serializable (オプション)#
  
  リクエストのポストデータを設定できます。dataパラメータがオブジェクトの場合、json文字列にシリアライズされ、content-typeヘッダーが明示的に設定されていない場合はapplication/jsonに設定されます。それ以外の場合、content-typeヘッダーは明示的に設定されていない場合はapplication/octet-streamに設定されます。
- failOnStatusCode boolean (オプション)#
  
  2xxおよび3xx以外のレスポンスコードでエラーをスローするかどうか。デフォルトでは、すべてのステータスコードに対してレスポンスオブジェクトが返されます。
- form Object<string, string | number | boolean> | FormData (オプション)#
  
  application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りapplication/x-www-form-urlencodedに設定されます。
- headers Object<string, string> (オプション)#
  
  HTTPヘッダーを設定できます。これらのヘッダーは、フェッチされたリクエストと、それによって開始されたリダイレクトにも適用されます。
- ignoreHTTPSErrors boolean (オプション)#
  
  ネットワークリクエストを送信するときにHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- maxRedirects number (オプション)追加: v1.26#
  
  自動的に追跡されるリクエストリダイレクトの最大数。数を超えるとエラーがスローされます。デフォルトは20です。リダイレクトを追跡しない場合は0を渡します。
- maxRetries number (オプション)追加: v1.46#
  
  ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTPレスポンスコードに基づいて再試行しません。制限を超えるとエラーがスローされます。デフォルトは0 - 再試行なし。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (オプション)#
  - name string
    
    ファイル名
  - mimeType string
    
    ファイルタイプ
  - buffer Buffer
    
    ファイルコンテンツ
  multipart/form-dataエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りmultipart/form-dataに設定されます。ファイルの値は、fs.ReadStreamまたはファイル名、mime-type、およびそのコンテンツを含むファイルライクオブジェクトとして渡すことができます。
- params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#
  
  URLとともに送信されるクエリパラメータ。
- timeout number (オプション)#
  
  リクエストタイムアウト（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。

戻り値

Promise<APIResponse>#

post

追加: v1.16

apiRequestContext.post

HTTP(S) POSTリクエストを送信し、そのレスポンスを返します。このメソッドは、コンテキストからリクエストCookieを設定し、レスポンスからコンテキストCookieを更新します。このメソッドは、自動的にリダイレクトに従います。

使用法

JSONオブジェクトは、リクエストに直接渡すことができます

await request.post('https://example.com/api/createBook', {
  data: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

フォームデータをサーバーに送信するには、formオプションを使用します。その値は、application/x-www-form-urlencodedエンコーディングでリクエストボディにエンコードされます（ファイルを送信するためにmultipart/form-dataフォームエンコーディングを使用する方法については、以下を参照してください）

await request.post('https://example.com/api/findBook', {
  form: {
    title: 'Book Title',
    author: 'John Doe',
  }
});

リクエストのボディでファイル（複数可）を送信する一般的な方法は、multipart/form-dataエンコーディングでフォームフィールドとしてアップロードすることです。FormDataを使用してリクエストボディを構築し、multipartパラメータとしてリクエストに渡します

const form = new FormData();
form.set('name', 'John');
form.append('name', 'Doe');
// Send two file fields with the same name.
form.append('file', new File(['console.log(2024);'], 'f1.js', { type: 'text/javascript' }));
form.append('file', new File(['hello'], 'f2.txt', { type: 'text/plain' }));
await request.post('https://example.com/api/uploadForm', {
  multipart: form
});

引数

url string #

ターゲットURL。
options Object (オプション)
- data string | Buffer | Serializable (オプション)#
  
  リクエストのポストデータを設定できます。dataパラメータがオブジェクトの場合、json文字列にシリアライズされ、content-typeヘッダーが明示的に設定されていない場合はapplication/jsonに設定されます。それ以外の場合、content-typeヘッダーは明示的に設定されていない場合はapplication/octet-streamに設定されます。
- failOnStatusCode boolean (オプション)#
  
  2xxおよび3xx以外のレスポンスコードでエラーをスローするかどうか。デフォルトでは、すべてのステータスコードに対してレスポンスオブジェクトが返されます。
- form Object<string, string | number | boolean> | FormData (オプション)#
  
  application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りapplication/x-www-form-urlencodedに設定されます。
- headers Object<string, string> (任意)#
  
  HTTPヘッダーを設定できます。これらのヘッダーは、フェッチされたリクエストと、それによって開始されたリダイレクトにも適用されます。
- ignoreHTTPSErrors boolean (任意)#
  
  ネットワークリクエストを送信するときにHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- maxRedirects number (オプション)追加: v1.26#
  
  自動的に追跡されるリクエストリダイレクトの最大数。数を超えるとエラーがスローされます。デフォルトは20です。リダイレクトを追跡しない場合は0を渡します。
- maxRetries number (オプション)追加: v1.46#
  
  ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTPレスポンスコードに基づいて再試行しません。制限を超えるとエラーがスローされます。デフォルトは0 - 再試行なし。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (任意)#
  - name string
    
    ファイル名
  - mimeType string
    
    ファイルタイプ
  - buffer Buffer
    
    ファイルコンテンツ
  multipart/form-dataエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りmultipart/form-dataに設定されます。ファイルの値は、fs.ReadStreamまたはファイル名、mime-type、およびそのコンテンツを含むファイルライクオブジェクトとして渡すことができます。
- params Object<string, string | number | boolean> | URLSearchParams | string (任意)#
  
  URLとともに送信されるクエリパラメータ。
- timeout number (任意)#
  
  リクエストタイムアウト（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。

戻り値

Promise<APIResponse>#

put

追加: v1.16

apiRequestContext.put

HTTP(S) PUT リクエストを送信し、そのレスポンスを返します。このメソッドは、コンテキストからリクエストクッキーを設定し、レスポンスからコンテキストクッキーを更新します。このメソッドは自動的にリダイレクトに従います。

使用法

await apiRequestContext.put(url);
await apiRequestContext.put(url, options);

引数

url string #

ターゲットURL。
options Object (オプション)
- data string | Buffer | Serializable (任意)#
  
  リクエストのポストデータを設定できます。dataパラメータがオブジェクトの場合、json文字列にシリアライズされ、content-typeヘッダーが明示的に設定されていない場合はapplication/jsonに設定されます。それ以外の場合、content-typeヘッダーは明示的に設定されていない場合はapplication/octet-streamに設定されます。
- failOnStatusCode boolean (任意)#
  
  2xxおよび3xx以外のレスポンスコードでエラーをスローするかどうか。デフォルトでは、すべてのステータスコードに対してレスポンスオブジェクトが返されます。
- form Object<string, string | number | boolean> | FormData (任意)#
  
  application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りapplication/x-www-form-urlencodedに設定されます。
- headers Object<string, string> (任意)#
  
  HTTPヘッダーを設定できます。これらのヘッダーは、フェッチされたリクエストと、それによって開始されたリダイレクトにも適用されます。
- ignoreHTTPSErrors boolean (任意)#
  
  ネットワークリクエストを送信するときにHTTPSエラーを無視するかどうか。デフォルトはfalseです。
- maxRedirects number (オプション)追加: v1.26#
  
  自動的に追跡されるリクエストリダイレクトの最大数。数を超えるとエラーがスローされます。デフォルトは20です。リダイレクトを追跡しない場合は0を渡します。
- maxRetries number (オプション)追加: v1.46#
  
  ネットワークエラーを再試行する最大回数。現在、ECONNRESETエラーのみが再試行されます。HTTPレスポンスコードに基づいて再試行しません。制限を超えるとエラーがスローされます。デフォルトは0 - 再試行なし。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (任意)#
  - name string
    
    ファイル名
  - mimeType string
    
    ファイルタイプ
  - buffer Buffer
    
    ファイルコンテンツ
  multipart/form-dataエンコーディングを使用してhtmlフォームとしてシリアライズされ、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、content-typeヘッダーは明示的に指定されない限りmultipart/form-dataに設定されます。ファイルの値は、fs.ReadStreamまたはファイル名、mime-type、およびそのコンテンツを含むファイルライクオブジェクトとして渡すことができます。
- params Object<string, string | number | boolean> | URLSearchParams | string (任意)#
  
  URLとともに送信されるクエリパラメータ。
- timeout number (任意)#
  
  リクエストタイムアウト（ミリ秒単位）。デフォルトは30000（30秒）です。タイムアウトを無効にするには0を渡します。

戻り値

Promise<APIResponse>#

storageState

追加: v1.16

apiRequestContext.storageState

このリクエストコンテキストのストレージ状態を返します。コンストラクタに渡された場合、現在のクッキーとローカルストレージのスナップショットが含まれます。

使用法

await apiRequestContext.storageState();
await apiRequestContext.storageState(options);

引数

options Object (オプション)
- indexedDB boolean (任意)Added in: v1.51#
  
  ストレージ状態のスナップショットに IndexedDB を含めるには、true に設定します。
- path string (任意)#
  
  ストレージ状態を保存するファイルパス。 path が相対パスの場合、現在の作業ディレクトリからの相対パスとして解決されます。パスが指定されていない場合でも、ストレージ状態は返されますが、ディスクには保存されません。

戻り値

Promise<Object>#
- cookies Array<Object>
  - name string
  - value string
  - domain string
  - path string
  - expires number
    
    Unix タイム（秒単位）。
  - httpOnly boolean
  - secure boolean
  - sameSite "Strict" | "Lax" | "None"
- origins Array<Object>
  - origin string
  - localStorage Array<Object>
    - name string
    - value string

メソッド​

delete​

dispose​

fetch​

get​

head​

patch​

post​

put​

storageState​

メソッド

delete

dispose

fetch

get

head

patch

post

put

storageState