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 来考虑 base URL。示例
- baseURL: http://localhost:3000 并发送请求到 /bar.html 将生成 http://localhost:3000/bar.html
- baseURL: http://localhost:3000/foo/ 并发送请求到 ./bar.html 将生成 http://localhost:3000/foo/bar.html
- baseURL: http://localhost:3000/foo (无尾随斜杠) 并导航到 ./bar.html 将生成 http://localhost: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 头部的对象。默认为无。
fail_on_status_code bool (可选)新增于: v1.51#

是否在响应码非 2xx 和 3xx 时抛出错误。默认情况下，所有状态码都会返回响应对象。
http_credentials Dict (可选)#
- username str
- password str
- origin str (可选)
  
  限制在特定源 (scheme://host:port).
- send "unauthorized" | "always" (可选)
  
  此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 每个 API 请求都会发送带有基本认证凭据的 Authorization 头部。'unauthorized - 凭据仅在收到带有 WWW-Authenticate 头部的 401 (Unauthorized) 响应时发送。默认为 'unauthorized'。
HTTP 认证的凭据。如果未指定源，则在收到未经授权的响应时，会将用户名和密码发送给任何服务器。
ignore_https_errors bool (可选)#

发送网络请求时是否忽略 HTTPS 错误。默认为 false。
max_redirects int (可选)新增于: v1.52#

将自动跟踪的最大请求重定向次数。如果超过此次数，将抛出错误。默认为 20。传递 0 表示不跟踪重定向。此设置可以针对每个请求单独覆盖。
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 List[Dict]
  - origin str
  - localStorage List[Dict]
    - name str
    - value str
使用给定的存储状态填充上下文。此选项可用于使用通过 browser_context.storage_state() 或 api_request_context.storage_state() 获取的登录信息初始化上下文。可以是包含保存的存储状态文件的路径，或是 browser_context.storage_state() 或 api_request_context.storage_state() 方法返回的值。
timeout float (可选)#

等待响应的最长时间（毫秒）。默认为 30000 (30 秒)。传递 0 表示禁用超时。
user_agent str (可选)#

在此上下文中使用的特定用户代理。

返回值

APIRequestContext #

方法​

new_context​

方法

new_context