APIRequestContext

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

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

クッキー管理

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

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

---

メソッド

delete

追加バージョン: v1.16 apiRequestContext.delete

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

使用方法

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

引数

• url string#

  ターゲットURL。

• options Object (オプション)

  • data string | Buffer | Serializable (オプション)追加バージョン: v1.17#

    リクエストのPOSTデータを設定できます。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タイプ、およびその内容を含むファイルライクなオブジェクトとして渡すことができます。

  • 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)リクエストを送信し、そのレスポンスを返します。このメソッドは、コンテキストからリクエストクッキーを設定し、レスポンスからコンテキストクッキーを更新します。メソッドは自動的にリダイレクトを追跡します。

使用方法

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 (オプション)#

    リクエストのPOSTデータを設定できます。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タイプ、およびその内容を含むファイルライクなオブジェクトとして渡すことができます。

  • params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#

    URLと一緒に送信するクエリパラメータ。

  • timeout number (オプション)#

    リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトを無効にします。

戻り値

• Promise<APIResponse>#

---

get

追加バージョン: v1.16 apiRequestContext.get

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

使用方法

リクエストパラメータは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#

    リクエストのPOSTデータを設定できます。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タイプ、およびその内容を含むファイルライクなオブジェクトとして渡すことができます。

  • params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#

    URLと一緒に送信するクエリパラメータ。

  • timeout number (オプション)#

    リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトを無効にします。

戻り値

• Promise<APIResponse>#

---

head

追加バージョン: v1.16 apiRequestContext.head

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

使用方法

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

引数

• url string#

  ターゲットURL。

• options Object (オプション)

  • data string | Buffer | Serializable (オプション)追加バージョン: v1.26#

    リクエストのPOSTデータを設定できます。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タイプ、およびその内容を含むファイルライクなオブジェクトとして渡すことができます。

  • params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#

    URLと一緒に送信するクエリパラメータ。

  • timeout number (オプション)#

    リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトを無効にします。

戻り値

• Promise<APIResponse>#

---

patch

追加バージョン: v1.16 apiRequestContext.patch

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

使用方法

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

引数

• url string#

  ターゲットURL。

• options Object (オプション)

  • data string | Buffer | Serializable (オプション)#

    リクエストのPOSTデータを設定できます。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タイプ、およびその内容を含むファイルライクなオブジェクトとして渡すことができます。

  • params Object<string, string | number | boolean> | URLSearchParams | string (オプション)#

    URLと一緒に送信するクエリパラメータ。

  • timeout number (オプション)#

    リクエストのタイムアウト（ミリ秒）。デフォルトは30000（30秒）です。0を渡すとタイムアウトを無効にします。

戻り値

• Promise<APIResponse>#

---

post

追加バージョン: v1.16 apiRequestContext.post

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

使用方法

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 (オプション)#

    リクエストのPOSTデータを設定できます。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タイプ、およびその内容を含むファイルライクなオブジェクトとして渡すことができます。

  • 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 (オプション)#

    リクエストのPOSTデータを設定できます。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タイプ、およびその内容を含むファイルライクなオブジェクトとして渡すことができます。

  • 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 (オプション)追加バージョン: 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