APIRequest

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

---

方法

newContext

添加于：v1.16 apiRequest.newContext

创建 APIRequestContext 的新实例。

用法

await apiRequest.newContext();
await apiRequest.newContext(options);

参数

• options Object (可选)

  • baseURL string (可选)#

    诸如 apiRequestContext.get() 之类的方法通过使用 URL() 构造函数来构建相应的 URL，从而将 baseURL 考虑在内。示例

    • 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

  • clientCertificates Array<Object> (可选)添加于: 1.46#

    • origin string

      证书有效的精确源。源包括 https 协议、主机名和可选的端口。

    • certPath string (可选)

      PEM 格式证书文件的路径。

    • cert Buffer (可选)

      PEM 格式证书的直接值。

    • keyPath string (可选)

      PEM 格式私钥文件的路径。

    • key Buffer (可选)

      PEM 格式私钥的直接值。

    • pfxPath string (可选)

      PFX 或 PKCS12 编码的私钥和证书链文件的路径。

    • pfx Buffer (可选)

      PFX 或 PKCS12 编码的私钥和证书链的直接值。

    • passphrase string (可选)

      私钥（PEM 或 PFX）的密码。

    TLS 客户端认证允许服务器请求并验证客户端证书。

    详情

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

    客户端证书认证仅在至少提供一个客户端证书时才有效。如果您想拒绝服务器发送的所有客户端证书，您需要提供一个 origin 与您计划访问的任何域都不匹配的客户端证书。

    注意

    在 macOS 上使用 WebKit 时，访问 localhost 将不会选取客户端证书。您可以通过将 localhost 替换为 local.playwright 来使其工作。

  • extraHTTPHeaders Object<string, string> (可选)#

    一个对象，包含要随每个请求发送的附加 HTTP 头。默认为无。

  • failOnStatusCode boolean (可选)添加于: v1.51#

    是否在除 2xx 和 3xx 之外的响应码时抛出错误。默认情况下，所有状态码都会返回响应对象。

  • httpCredentials Object (可选)#

    • username string

    • password string

    • origin string (可选)

      限制在特定源（scheme://host:port）上发送 http 凭据).

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

      此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 带有基本身份验证凭据的 Authorization 头将随每个 API 请求发送。'unauthorized - 凭据仅在收到带有 WWW-Authenticate 头的 401 (未经授权) 响应时发送。默认为 'unauthorized'。

    HTTP 认证的凭据。如果未指定源，则用户名和密码将在未经授权的响应时发送到任何服务器。

  • ignoreHTTPSErrors boolean (可选)#

    发送网络请求时是否忽略 HTTPS 错误。默认为 false。

  • maxRedirects number (可选)添加于: v1.52#

    将自动跟随的最大请求重定向次数。如果超过此数字，将抛出错误。默认为 20。传递 0 则不跟随重定向。这可以针对每个请求单独覆盖。

  • proxy Object (可选)#

    • server string

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

    • bypass string (可选)

      可选的逗号分隔的域以绕过代理，例如 ".com, chromium.org, .domain.com"。

    • username string (可选)

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

    • password string (可选)

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

    网络代理设置。

  • storageState string | Object (可选)#

    • cookies Array<Object>

      • name string

      • value string

      • domain string

      • path string

      • expires number

        Unix 时间戳，单位为秒。

      • httpOnly boolean

      • secure boolean

      • sameSite "Strict" | "Lax" | "None"

    • origins Array<Object>

      • origin string

      • localStorage Array<Object>

        • name string

        • value string

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

  • timeout number (可选)#

    等待响应的最大时间（毫秒）。默认为 30000（30 秒）。传递 0 以禁用超时。

  • userAgent string (可选)#

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

返回

• Promise<APIRequestContext>#