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 来考虑基本 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
- clientCertificates Array<Object> (可选)添加于：1.46#
  - origin string
    
    证书有效的精确来源（Origin）。来源包括 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' - 每次 API 请求都会发送包含基本身份验证凭据的 Authorization 头部。'unauthorized - 凭据仅在收到包含 WWW-Authenticate 头部且状态码为 401 (Unauthorized) 的响应时发送。默认为 '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>#

方法​

newContext​

方法

newContext