跳转到主要内容

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://:3000，向 /bar.html 发送请求，结果为 https://:3000/bar.html
    • baseURL: https://:3000/foo/，向 ./bar.html 发送请求，结果为 https://:3000/foo/bar.html
    • baseURL: https://:3000/foo (不带尾部斜杠)，导航到 ./bar.html，结果为 https://: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 属性应与证书有效的请求源精确匹配。

    客户端证书认证仅在至少提供一个客户端证书时才有效。如果您想拒绝服务器发送的所有客户端证书，则需要提供一个 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）上发送 http 凭据).

    • send "unauthorized" | "always" (可选)

      此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 每次 API 请求都将发送包含基本身份验证凭据的 Authorization 标头。'unauthorized - 凭据仅在收到带有 WWW-Authenticate 标头的 401 (未经授权) 响应时发送。默认为 '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 (可选)#

    使用给定的存储状态填充上下文。此选项可用于使用通过 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 (可选)#

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

返回