APIRequest

提供可用于 Web API 测试的 API。该类用于创建 APIRequestContext 实例，进而可用于发送 Web 请求。可以通过 playwright.request 获取此类的实例。更多信息请参阅 APIRequestContext。

方法

new_context

创建 APIRequestContext 的新实例。

用法

api_request.new_context()
api_request.new_context(**kwargs)

参数

• base_url 字符串类型（可选） 像api_request_context.get()这样的方法会通过使用URL()构造函数来使用基本URL并构建相应的URL，示例：

  • baseURL: http://localhost:3000 发送请求到/bar.html 返回的url是 http://localhost:3000/bar.html

• extra_http_headers 字典类型（可选） 一个包含额外的HTTP标头的对象，将与每个请求一起发送。默认为无。

• http_credentials 字典类型（可选）

  • username 字符串
  • password 字符串
  • origin 字符串（可选）限制在特定的来源（scheme://host:port）上发送HTTP。 HTTP身份验证的凭据。如果未指定来源，用户名和密码将在未经授权的响应时发送到任何服务器。

• ignore_https_errors 布尔类型（可选）是否忽略http的错误，默认为否。

• proxy 字典类型（可选）

  • server 字符串

  用于所有请求的代理。支持HTTP和SOCKS代理，例如http://myproxy.com:3128或socks5://myproxy.com:3128。简写形式myproxy.com:3128被视为HTTP代理。

  • bypass 字符串（可选）

  可用逗号分隔域名，用于绕过代理，例如“.com，chromium.org，.domain.com”。

  • username 字符串（可选）

  如果HTTP代理需要身份验证，则可选使用的用户名。

  • password 字符串（可选）

  如果要身份验证，则可选用密码。

• storage_state 可选参数，类型可以是字符串、字典和pathlib.Path。

  • cookies 字典或列表类型

  • origins 字典或列表类型

使用给定的存储状态填充上下文。此选项可用于使用通过 browser_context.storage_state() 或 api_request_context.storage_state() 获取的已登录信息初始化上下文。可以是保存有存储数据的文件路径，也可以是 browser_context.storage_state() 或 api_request_context.storage_state() 方法返回的值。

• timeout 浮点类型（可选）

等待响应的最长时间，单位为毫秒。默认为30000（30秒）。将其设置为0以禁用超时。

• user_agent 字符串类型（可选）

返回值

• APIRequestContext