APIRequestContext

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

¥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 管理

¥Cookie management

BrowserContext.request() 返回的 APIRequestContext 和 Page.request() 与相应的 BrowserContext 共享 cookie 存储。每个 API 请求都会有 Cookie 标头，其中填充了浏览器上下文中的值。如果 API 响应包含 Set-Cookie 标头，它将自动更新 BrowserContext cookie，并且从页面触发的请求将获取它们。这意味着，如果你使用此 API 登录，你的 e2e 测试将被登录，反之亦然。

¥APIRequestContext returned by BrowserContext.request() and Page.request() shares cookie storage with the corresponding BrowserContext. Each API request will have Cookie header populated with the values from the browser context. If the API response contains Set-Cookie header it will automatically update BrowserContext cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be logged in and vice versa.

如果你希望 API 请求不干扰浏览器 cookie，你应该通过调用 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.

用法

¥Usage

APIRequestContext.delete(url);
APIRequestContext.delete(url, options);

参数

¥Arguments

url String #

目标网址。

¥Target URL.

options RequestOptions (optional) Added in: v1.18#

可选请求参数。

¥Optional request parameters.

¥Returns

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.

用法

¥Usage

APIRequestContext.dispose();
APIRequestContext.dispose(options);

参数

¥Arguments

options ApiRequestContext.DisposeOptions（可选）

¥options ApiRequestContext.DisposeOptions (optional)
- setReason String (optional) Added in: v1.45#

报告上下文处置中断操作的原因。

¥The reason to be reported to the operations interrupted by the context disposal.

¥Returns

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.

用法

¥Usage

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

¥JSON objects can be passed directly to the request:

Map<String, Object> data = new HashMap();
data.put("title", "Book Title");
data.put("body", "John Doe");
request.fetch("https://example.com/api/createBook", RequestOptions.create().setMethod("post").setData(data));

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

¥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:

// Pass file path to the form data constructor:
Path file = Paths.get("team.csv");
APIResponse response = request.fetch("https://example.com/api/uploadTeamList",
  RequestOptions.create().setMethod("post").setMultipart(
    FormData.create().set("fileField", file)));

// Or you can pass the file content directly as FilePayload object:
FilePayload filePayload = new FilePayload("f.js", "text/javascript",
      "console.log(2022);".getBytes(StandardCharsets.UTF_8));
APIResponse response = request.fetch("https://example.com/api/uploadScript",
  RequestOptions.create().setMethod("post").setMultipart(
    FormData.create().set("fileField", filePayload)));

参数

¥Arguments

urlOrRequest String | Request #

从中获取所有参数的目标 URL 或请求。

¥Target URL or Request to get all parameters from.

options RequestOptions (optional) Added in: v1.18#

可选请求参数。

¥Optional request parameters.

¥Returns

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.

用法

¥Usage

请求参数可以使用 params 选项进行配置，它们将被序列化为 URL 搜索参数：

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

request.get("https://example.com/api/getText", RequestOptions.create()
  .setQueryParam("isbn", "1234")
  .setQueryParam("page", 23));

参数

¥Arguments

url String #

目标网址。

¥Target URL.

options RequestOptions (optional) Added in: v1.18#

可选请求参数。

¥Optional request parameters.

¥Returns

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.

用法

¥Usage

APIRequestContext.head(url);
APIRequestContext.head(url, options);

参数

¥Arguments

url String #

目标网址。

¥Target URL.

options RequestOptions (optional) Added in: v1.18#

可选请求参数。

¥Optional request parameters.

¥Returns

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.

用法

¥Usage

APIRequestContext.patch(url);
APIRequestContext.patch(url, options);

参数

¥Arguments

url String #

目标网址。

¥Target URL.

options RequestOptions (optional) Added in: v1.18#

可选请求参数。

¥Optional request parameters.

¥Returns

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.

用法

¥Usage

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

¥JSON objects can be passed directly to the request:

Map<String, Object> data = new HashMap();
data.put("title", "Book Title");
data.put("body", "John Doe");
request.post("https://example.com/api/createBook", RequestOptions.create().setData(data));

要将表单数据发送到服务器，请使用 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):

request.post("https://example.com/api/findBook", RequestOptions.create().setForm(
    FormData.create().set("title", "Book Title").set("body", "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:

// Pass file path to the form data constructor:
Path file = Paths.get("team.csv");
APIResponse response = request.post("https://example.com/api/uploadTeamList",
  RequestOptions.create().setMultipart(
    FormData.create().set("fileField", file)));

// Or you can pass the file content directly as FilePayload object:
FilePayload filePayload1 = new FilePayload("f1.js", "text/javascript",
      "console.log(2022);".getBytes(StandardCharsets.UTF_8));
APIResponse response = request.post("https://example.com/api/uploadScript",
  RequestOptions.create().setMultipart(
    FormData.create().set("fileField", filePayload)));

参数

¥Arguments

url String #

目标网址。

¥Target URL.

options RequestOptions (optional) Added in: v1.18#

可选请求参数。

¥Optional request parameters.

¥Returns

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.

用法

¥Usage

APIRequestContext.put(url);
APIRequestContext.put(url, options);

参数

¥Arguments

url String #

目标网址。

¥Target URL.

options RequestOptions (optional) Added in: v1.18#

可选请求参数。

¥Optional request parameters.

¥Returns

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.

用法

¥Usage

APIRequestContext.storageState();
APIRequestContext.storageState(options);

参数

¥Arguments

options ApiRequestContext.StorageStateOptions（可选）

¥options ApiRequestContext.StorageStateOptions (optional)
- setIndexedDB boolean (optional) Added in: v1.51#

设置为 true 以将 IndexedDB 包含在存储状态快照中。

¥Set to true to include IndexedDB in the storage state snapshot.

setPath Path (optional)#

保存存储状态的文件路径。如果 setPath 是相对路径，则相对于当前工作目录进行解析。如果未提供路径，仍会返回存储状态，但不会保存到磁盘。

¥The file path to save the storage state to. If setPath is a relative path, then it is resolved relative to current working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.

¥Returns

String #

方法​

delete​

dispose​

fetch​

get​

head​

patch​

post​

put​

storageState​

方法

delete

dispose

fetch

get

head

patch

post

put

storageState