APIRequest

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

方法

new_context

添加于：v1.16

apiRequest.new_context

创建 APIRequestContext 的新实例。

用法

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

参数

base_url str (可选)#

诸如 api_request_context.get() 之类的方法通过使用 URL() 构造函数构建相应的 URL 来考虑基本 URL。示例
- baseURL：https://127.0.0.1:3000 并向 /bar.html 发送请求导致 https://127.0.0.1:3000/bar.html
- baseURL：https://127.0.0.1:3000/foo/ 并向 ./bar.html 发送请求导致 https://127.0.0.1:3000/foo/bar.html
- baseURL：https://127.0.0.1:3000/foo（没有尾部斜杠）并导航到 ./bar.html 导致 https://127.0.0.1:3000/bar.html
client_certificates List[Dict] (可选)添加于：1.46#
- origin str
  
  证书对有效请求的精确来源。来源包括 https 协议、主机名和可选端口。
- certPath Union[str, pathlib.Path] (可选)
  
  PEM 格式证书文件的路径。
- cert bytes (可选)
  
  PEM 格式证书的直接值。
- keyPath Union[str, pathlib.Path] (可选)
  
  PEM 格式私钥文件的路径。
- key bytes (可选)
  
  PEM 格式私钥的直接值。
- pfxPath Union[str, pathlib.Path] (可选)
  
  PFX 或 PKCS12 编码的私钥和证书链的路径。
- pfx bytes (可选)
  
  PFX 或 PKCS12 编码的私钥和证书链的直接值。
- passphrase str (可选)
  
  私钥（PEM 或 PFX）的密码。
TLS 客户端身份验证允许服务器请求客户端证书并对其进行验证。

详情

要使用的客户端证书数组。每个证书对象必须同时具有 certPath 和 keyPath、单个 pfxPath 或其对应的直接值等效项（cert 和 key 或 pfx）。如果证书已加密，则可以选择提供 passphrase 属性。应使用与证书对有效请求的来源完全匹配的 origin 属性。

注意
在 macOS 上使用 WebKit 时，访问 localhost 将不会获取客户端证书。您可以通过将 localhost 替换为 local.playwright 来使其工作。
extra_http_headers Dict[str, str] (可选)#

包含要与每个请求一起发送的其他 HTTP 标头的对象。默认为无。
http_credentials Dict (可选)#
- username str
- password str
- origin str (可选)
  
  限制在特定来源（scheme://host:port).
- send "unauthorized" | "always" (可选)
  
  此选项仅适用于从相应的 APIRequestContext 发送的请求，并且不影响从浏览器发送的请求。'always' - 每个 API 请求都将发送带有基本身份验证凭据的 Authorization 标头。'unauthorized - 仅在收到带有 WWW-Authenticate 标头的 401（未授权）响应时才发送凭据。默认为 'unauthorized'。
用于 HTTP 身份验证的凭据。如果未指定来源，则在未授权的响应中将用户名和密码发送到任何服务器。
ignore_https_errors bool (可选)#

发送网络请求时是否忽略 HTTPS 错误。默认为 false。
proxy Dict (可选)#
- server str
  
  用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。简写形式 myproxy.com:3128 被视为 HTTP 代理。
- bypass str (可选)
  
  可选的逗号分隔的域名以绕过代理，例如 ".com, chromium.org, .domain.com"。
- username str (可选)
  
  如果 HTTP 代理需要身份验证，则使用可选用户名。
- password str (可选)
  
  如果 HTTP 代理需要身份验证，则使用可选密码。
网络代理设置。
storage_state Union[str, pathlib.Path] | Dict (可选)#
- cookies List[Dict]
  - name str
  - value str
  - domain str
  - path str
  - expires float
    
    以秒为单位的 Unix 时间。
  - httpOnly bool
  - secure bool
  - sameSite "Strict" | "Lax" | "None"
- origins 列表[字典]
  - origin str
  - localStorage 列表[字典]
    - name str
    - value str
使用给定的存储状态填充上下文。此选项可用于使用通过 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 #

方法​

new_context​

方法

new_context