APIRequestContext

此 API 用于 Web API 测试。你可以使用它来触发 API 端点、配置微服务、准备环境或为端到端测试准备服务。

🌐 This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare environment or the service to your e2e test.

每个 Playwright 浏览器上下文都关联有一个 APIRequestContext 实例，该实例与浏览器上下文共享 cookie 存储，并且可以通过 browserContext.request 或 page.request 访问。也可以通过调用 apiRequest.newContext() 手动创建一个新的 APIRequestContext 实例。

🌐 Each Playwright browser context has associated with it APIRequestContext instance which shares cookie storage with the browser context and can be accessed via browserContext.request or page.request. It is also possible to create a new APIRequestContext instance manually by calling apiRequest.newContext().

Cookie 管理

APIRequestContext 由 browserContext.request 和 page.request 返回，并与相应的 BrowserContext 共享 Cookie 存储。每个 API 请求的 Cookie 头部将会被填充为浏览器上下文中的值。如果 API 响应包含 Set-Cookie 头部，它会自动更新 BrowserContext 的 Cookie，并且页面发出的请求将会使用这些 Cookie。这意味着，如果你使用该 API 登录，你的端到端测试也将会登录，反之亦然。

如果你希望 API 请求不干扰浏览器的 cookies，你应该通过调用 apiRequest.newContext() 创建一个新的 APIRequestContext。这样的 APIRequestContext 对象将拥有自己独立的 cookie 存储。

🌐 If you want API requests to not interfere with the browser cookies you should create a new APIRequestContext by calling apiRequest.newContext(). Such APIRequestContext object will have its own isolated cookie storage.

方法

🌐 Methods

delete

Added in: v1.16

apiRequestContext.delete

发送 HTTP(S) DELETE 请求并返回其响应。该方法会从上下文中填充请求的 cookie，并根据响应更新上下文中的 cookie。该方法会自动跟随重定向。

🌐 Sends HTTP(S) DELETE request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

用法

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

参数

url string #

目标网址。
options Object (optional)
- data string | Buffer | Serializable (optional) Added in: v1.17#
  
  允许设置请求的 POST 数据。如果 data 参数是一个对象，它将被序列化为 JSON 字符串，并且如果未显式设置，content-type 头将被设置为 application/json。否则，如果未显式设置，content-type 头将被设置为 application/octet-stream。
- failOnStatusCode boolean (optional)#
  
  是否对除了 2xx 和 3xx 之外的响应代码抛出异常。默认情况下，响应对象会返回所有状态代码。
- form Object<string, string | number | boolean> | FormData (optional) Added in: 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 (optional) Added in: v1.26#
  
  自动跟随的请求重定向的最大次数。如果超过该次数，将抛出错误。默认值为 20。传入 0 可不跟随重定向。
- maxRetries number (optional) Added in: v1.46#
  
  网络错误应重试的最大次数。目前仅重试 ECONNRESET 错误。不基于 HTTP 响应码进行重试。如果超过限制，将抛出错误。默认值为 0 - 不重试。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional) Added in: 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

Added in: v1.16

apiRequestContext.dispose

apiRequestContext.get() 和类似方法返回的所有响应都会被存储在内存中，以便你以后可以调用 apiResponse.body()。此方法会释放其所有资源，对已释放的 APIRequestContext 调用任何方法都会抛出异常。

🌐 All responses returned by apiRequestContext.get() and similar methods are stored in the memory, so that you can later call apiResponse.body().This method discards all its resources, calling any method on disposed APIRequestContext will throw an exception.

用法

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

参数

options Object (optional)
- reason string (optional) Added in: v1.45#
  
  报告上下文处置中断操作的原因。

Promise<void>#

fetch

Added in: v1.16

apiRequestContext.fetch

发送 HTTP(S) 请求并返回其响应。该方法会从上下文中填充请求的 cookie，并从响应中更新上下文 cookie。该方法会自动跟随重定向。

🌐 Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

用法

JSON 对象可以直接传递给请求：

🌐 JSON objects can be passed directly to the request:

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

在请求正文中发送文件的常见方式是将它们作为表单字段上传，使用 multipart/form-data 编码，通过指定 multipart 参数：

🌐 The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding, by specifiying the multipart parameter:

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 数据。如果 data 参数是一个对象，它将被序列化为 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 (optional) Added in: v1.26#
  
  自动跟随的请求重定向的最大次数。如果超过该次数，将抛出错误。默认值为 20。传入 0 可不跟随重定向。
- maxRetries number (optional) Added in: 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

Added in: v1.16

apiRequestContext.get

发送 HTTP(S) GET 请求并返回其响应。该方法会从上下文中填充请求的 cookie，并根据响应更新上下文中的 cookie。该方法会自动跟随重定向。

🌐 Sends HTTP(S) GET request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

用法

请求参数可以通过 params 选项进行配置，它们将被序列化为 URL 查询参数：

🌐 Request parameters can be configured with params option, they will be serialized into the URL search parameters:

// 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 #

目标网址。
options Object (optional)
- data string | Buffer | Serializable (optional) Added in: v1.26#
  
  允许设置请求的 POST 数据。如果 data 参数是一个对象，它将被序列化为 JSON 字符串，并且如果未显式设置，content-type 头将被设置为 application/json。否则，如果未显式设置，content-type 头将被设置为 application/octet-stream。
- failOnStatusCode boolean (optional)#
  
  是否对除了 2xx 和 3xx 之外的响应代码抛出异常。默认情况下，响应对象会返回所有状态代码。
- form Object<string, string | number | boolean> | FormData (optional) Added in: 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 (optional) Added in: v1.26#
  
  自动跟随的请求重定向的最大次数。如果超过该次数，将抛出错误。默认值为 20。传入 0 可不跟随重定向。
- maxRetries number (optional) Added in: v1.46#
  
  网络错误应重试的最大次数。目前仅重试 ECONNRESET 错误。不基于 HTTP 响应码进行重试。如果超过限制，将抛出错误。默认值为 0 - 不重试。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional) Added in: 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

Added in: v1.16

apiRequestContext.head

发送 HTTP(S) HEAD 请求并返回其响应。该方法会从上下文中填充请求的 cookie，并根据响应更新上下文中的 cookie。该方法会自动跟随重定向。

🌐 Sends HTTP(S) HEAD request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

用法

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

参数

url string #

目标网址。
options Object (optional)
- data string | Buffer | Serializable (optional) Added in: v1.26#
  
  允许设置请求的 POST 数据。如果 data 参数是一个对象，它将被序列化为 JSON 字符串，并且如果未显式设置，content-type 头将被设置为 application/json。否则，如果未显式设置，content-type 头将被设置为 application/octet-stream。
- failOnStatusCode boolean (optional)#
  
  是否对除了 2xx 和 3xx 之外的响应代码抛出异常。默认情况下，响应对象会返回所有状态代码。
- form Object<string, string | number | boolean> | FormData (optional) Added in: 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 (optional) Added in: v1.26#
  
  自动跟随的请求重定向的最大次数。如果超过该次数，将抛出错误。默认值为 20。传入 0 可不跟随重定向。
- maxRetries number (optional) Added in: v1.46#
  
  网络错误应重试的最大次数。目前仅重试 ECONNRESET 错误。不基于 HTTP 响应码进行重试。如果超过限制，将抛出错误。默认值为 0 - 不重试。
- multipart FormData | Object<string, string | number | boolean | ReadStream | Object> (optional) Added in: 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

Added in: v1.16

apiRequestContext.patch

发送 HTTP(S) PATCH 请求并返回其响应。该方法会从上下文中填充请求的 cookie，并根据响应更新上下文中的 cookie。该方法会自动跟随重定向。

🌐 Sends HTTP(S) PATCH request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

用法

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

参数

url string #

目标网址。
options Object (optional)
- data string | Buffer | Serializable (optional)#
  
  允许设置请求的 POST 数据。如果 data 参数是一个对象，它将被序列化为 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 (optional) Added in: v1.26#
  
  自动跟随的请求重定向的最大次数。如果超过该次数，将抛出错误。默认值为 20。传入 0 可不跟随重定向。
- maxRetries number (optional) Added in: 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

Added in: v1.16

apiRequestContext.post

发送 HTTP(S) POST 请求并返回其响应。该方法会从上下文中填充请求的 cookie，并根据响应更新上下文中的 cookie。该方法会自动跟随重定向。

🌐 Sends HTTP(S) POST request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

用法

JSON 对象可以直接传递给请求：

🌐 JSON objects can be passed directly to the request:

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

要将表单数据发送到服务器，请使用 form 选项。其值将使用 application/x-www-form-urlencoded 编码方式编码到请求正文中（下面介绍如何使用 multipart/form-data 表单编码发送文件）：

🌐 To send form data to the server use form option. Its value will be encoded into the request body with application/x-www-form-urlencoded encoding (see below how to use multipart/form-data form encoding to send files):

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

在请求体中发送文件的常见方法是将它们作为表单字段上传，并使用 multipart/form-data 编码。使用 FormData 构建请求体，并将其作为 multipart 参数传递给请求：

🌐 The common way to send file(s) in the body of a request is to upload them as form fields with multipart/form-data encoding. Use FormData to construct request body and pass it to the request as multipart parameter:

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 #

目标网址。
options Object (optional)
- data string | Buffer | Serializable (optional)#
  
  允许设置请求的 POST 数据。如果 data 参数是一个对象，它将被序列化为 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 (optional) Added in: v1.26#
  
  自动跟随的请求重定向的最大次数。如果超过该次数，将抛出错误。默认值为 20。传入 0 可不跟随重定向。
- maxRetries number (optional) Added in: 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

Added in: v1.16

apiRequestContext.put

发送 HTTP(S) PUT 请求并返回其响应。该方法会从上下文中填充请求的 cookie，并从响应中更新上下文的 cookie。该方法会自动跟随重定向。

🌐 Sends HTTP(S) PUT request and returns its response. The method will populate request cookies from the context and update context cookies from the response. The method will automatically follow redirects.

用法

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

参数

url string #

目标网址。
options Object (optional)
- data string | Buffer | Serializable (optional)#
  
  允许设置请求的 POST 数据。如果 data 参数是一个对象，它将被序列化为 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 (optional) Added in: v1.26#
  
  自动跟随的请求重定向的最大次数。如果超过该次数，将抛出错误。默认值为 20。传入 0 可不跟随重定向。
- maxRetries number (optional) Added in: 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

Added in: v1.16

apiRequestContext.storageState

返回此请求上下文的存储状态，包含当前 cookie 和本地存储快照（如果已传递给构造函数）。

🌐 Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.

用法

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

参数

options Object (optional)
- indexedDB boolean (optional) Added in: v1.51#
  
  设置为 true 以在存储状态快照中包含 IndexedDB。
- 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 “严格” | “宽松” | “无”
- 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