APIRequestContext

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

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

クッキー管理

browserContext.requestおよびpage.requestによって返されるAPIRequestContextは、対応する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 (optional)

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

    リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限り content-type ヘッダーは application/json に設定されます。それ以外の場合、明示的に設定されていない限り content-type ヘッダーは application/octet-stream に設定されます。

  • failOnStatusCode boolean (optional)#

    2xxおよび3xx以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードでレスポンスオブジェクトが返されます。

  • form Object<string, string | number | boolean> | FormData (optional)追加バージョン: v1.17#

    application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアル化され、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、明示的に提供されない限り、content-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

  • headers Object<string, string> (optional)#

    HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

  • ignoreHTTPSErrors boolean (optional)#

    ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

  • maxRedirects number (オプション)追加バージョン: v1.26#

    自動的にフォローされるリクエストのリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトをフォローしない場合は 0 を渡します。

  • maxRetries number (optional)追加バージョン: v1.46#

    ネットワークエラーが再試行される最大回数。現在、ECONNRESET エラーのみが再試行されます。HTTP応答コードに基づく再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは 0 (再試行なし) です。

  • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional)追加バージョン: 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 (optional)#

    URLとともに送信されるクエリパラメータ。

  • timeout number (optional)#

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

戻り値

• Promise<APIResponse>#

---

dispose

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

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

使用法

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

引数

• options Object (optional)

  • reason string (optional)追加されたバージョン: 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 (optional)

  • data string | Buffer | Serializable (optional)#

    リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限り content-type ヘッダーは application/json に設定されます。それ以外の場合、明示的に設定されていない限り content-type ヘッダーは application/octet-stream に設定されます。

  • failOnStatusCode boolean (optional)#

    2xxおよび3xx以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードでレスポンスオブジェクトが返されます。

  • form Object<string, string | number | boolean> | FormData (optional)#

    application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアル化され、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、明示的に提供されない限り、content-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

  • headers Object<string, string> (optional)#

    HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

  • ignoreHTTPSErrors boolean (optional)#

    ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

  • maxRedirects number (オプション)追加バージョン: v1.26#

    自動的にフォローされるリクエストのリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトをフォローしない場合は 0 を渡します。

  • maxRetries number (optional)追加バージョン: v1.46#

    ネットワークエラーが再試行される最大回数。現在、ECONNRESET エラーのみが再試行されます。HTTP応答コードに基づく再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは 0 (再試行なし) です。

  • method string (optional)#

    設定されている場合、フェッチメソッドを変更します（例：PUTまたはPOST）。指定されていない場合、GETメソッドが使用されます。

  • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional)#

    • 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 (optional)#

    URLとともに送信されるクエリパラメータ。

  • timeout number (optional)#

    リクエストのタイムアウト（ミリ秒単位）。デフォルトは 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 (optional)

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

    リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限り content-type ヘッダーは application/json に設定されます。それ以外の場合、明示的に設定されていない限り content-type ヘッダーは application/octet-stream に設定されます。

  • failOnStatusCode boolean (optional)#

    2xxおよび3xx以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードでレスポンスオブジェクトが返されます。

  • form Object<string, string | number | boolean> | FormData (optional)追加バージョン: v1.26#

    application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアル化され、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、明示的に提供されない限り、content-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

  • headers Object<string, string> (optional)#

    HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

  • ignoreHTTPSErrors boolean (optional)#

    ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

  • maxRedirects number (オプション)追加バージョン: v1.26#

    自動的にフォローされるリクエストのリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトをフォローしない場合は 0 を渡します。

  • maxRetries number (optional)追加バージョン: v1.46#

    ネットワークエラーが再試行される最大回数。現在、ECONNRESET エラーのみが再試行されます。HTTP応答コードに基づく再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは 0 (再試行なし) です。

  • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional)追加バージョン: 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 (optional)#

    URLとともに送信されるクエリパラメータ。

  • timeout number (optional)#

    リクエストのタイムアウト（ミリ秒単位）。デフォルトは 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 (optional)

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

    リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限り content-type ヘッダーは application/json に設定されます。それ以外の場合、明示的に設定されていない限り content-type ヘッダーは application/octet-stream に設定されます。

  • failOnStatusCode boolean (optional)#

    2xxおよび3xx以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードでレスポンスオブジェクトが返されます。

  • form Object<string, string | number | boolean> | FormData (optional)追加バージョン: v1.26#

    application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアル化され、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、明示的に提供されない限り、content-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

  • headers Object<string, string> (optional)#

    HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

  • ignoreHTTPSErrors boolean (optional)#

    ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

  • maxRedirects number (オプション)追加バージョン: v1.26#

    自動的にフォローされるリクエストのリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトをフォローしない場合は 0 を渡します。

  • maxRetries number (optional)追加バージョン: v1.46#

    ネットワークエラーが再試行される最大回数。現在、ECONNRESET エラーのみが再試行されます。HTTP応答コードに基づく再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは 0 (再試行なし) です。

  • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional)追加バージョン: 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 (optional)#

    URLとともに送信されるクエリパラメータ。

  • timeout number (optional)#

    リクエストのタイムアウト（ミリ秒単位）。デフォルトは 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 (optional)

  • data string | Buffer | Serializable (optional)#

    リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限り content-type ヘッダーは application/json に設定されます。それ以外の場合、明示的に設定されていない限り content-type ヘッダーは application/octet-stream に設定されます。

  • failOnStatusCode boolean (optional)#

    2xxおよび3xx以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードでレスポンスオブジェクトが返されます。

  • form Object<string, string | number | boolean> | FormData (optional)#

    application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアル化され、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、明示的に提供されない限り、content-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

  • headers Object<string, string> (optional)#

    HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

  • ignoreHTTPSErrors boolean (optional)#

    ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

  • maxRedirects number (オプション)追加バージョン: v1.26#

    自動的にフォローされるリクエストのリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトをフォローしない場合は 0 を渡します。

  • maxRetries number (optional)追加バージョン: v1.46#

    ネットワークエラーが再試行される最大回数。現在、ECONNRESET エラーのみが再試行されます。HTTP応答コードに基づく再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは 0 (再試行なし) です。

  • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional)#

    • 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 (optional)#

    URLとともに送信されるクエリパラメータ。

  • timeout number (optional)#

    リクエストのタイムアウト（ミリ秒単位）。デフォルトは 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 (optional)

  • data string | Buffer | Serializable (optional)#

    リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限り content-type ヘッダーは application/json に設定されます。それ以外の場合、明示的に設定されていない限り content-type ヘッダーは application/octet-stream に設定されます。

  • failOnStatusCode boolean (optional)#

    2xxおよび3xx以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードでレスポンスオブジェクトが返されます。

  • form Object<string, string | number | boolean> | FormData (optional)#

    application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアル化され、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、明示的に提供されない限り、content-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

  • headers Object<string, string> (optional)#

    HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

  • ignoreHTTPSErrors boolean (optional)#

    ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

  • maxRedirects number (オプション)追加バージョン: v1.26#

    自動的にフォローされるリクエストのリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトをフォローしない場合は 0 を渡します。

  • maxRetries number (optional)追加バージョン: v1.46#

    ネットワークエラーが再試行される最大回数。現在、ECONNRESET エラーのみが再試行されます。HTTP応答コードに基づく再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは 0 (再試行なし) です。

  • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional)#

    • 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 (optional)#

    URLとともに送信されるクエリパラメータ。

  • timeout number (optional)#

    リクエストのタイムアウト（ミリ秒単位）。デフォルトは 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 (optional)

  • data string | Buffer | Serializable (optional)#

    リクエストのPOSTデータを設定できます。データパラメータがオブジェクトの場合、JSON文字列にシリアル化され、明示的に設定されていない限り content-type ヘッダーは application/json に設定されます。それ以外の場合、明示的に設定されていない限り content-type ヘッダーは application/octet-stream に設定されます。

  • failOnStatusCode boolean (optional)#

    2xxおよび3xx以外のレスポンスコードで例外をスローするかどうか。デフォルトでは、すべてのステータスコードでレスポンスオブジェクトが返されます。

  • form Object<string, string | number | boolean> | FormData (optional)#

    application/x-www-form-urlencodedエンコーディングを使用してhtmlフォームとしてシリアル化され、このリクエストボディとして送信されるオブジェクトを提供します。このパラメータが指定されている場合、明示的に提供されない限り、content-typeヘッダーはapplication/x-www-form-urlencodedに設定されます。

  • headers Object<string, string> (optional)#

    HTTPヘッダーを設定できます。これらのヘッダーは、取得されたリクエストおよびそれによって開始されたすべてのリダイレクトに適用されます。

  • ignoreHTTPSErrors boolean (optional)#

    ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

  • maxRedirects number (オプション)追加バージョン: v1.26#

    自動的にフォローされるリクエストのリダイレクトの最大数。この数を超えるとエラーがスローされます。デフォルトは 20 です。リダイレクトをフォローしない場合は 0 を渡します。

  • maxRetries number (optional)追加バージョン: v1.46#

    ネットワークエラーが再試行される最大回数。現在、ECONNRESET エラーのみが再試行されます。HTTP応答コードに基づく再試行は行われません。制限を超えるとエラーがスローされます。デフォルトは 0 (再試行なし) です。

  • multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional)#

    • 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 (optional)#

    URLとともに送信されるクエリパラメータ。

  • timeout number (optional)#

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

戻り値

• Promise<APIResponse>#

---

storageState

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

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

使用法

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

引数

• options Object (optional)

  • indexedDB boolean (optional)追加バージョン: v1.51#

    ストレージ状態のスナップショットにIndexedDBを含めるには、trueに設定します。

  • path string (optional)#

    ストレージ状態を保存するファイルパス。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