APIRequest

暴露了可用于 Web API 测试的 API。此类别用于创建 APIRequestContext 实例，该实例可用于发送 Web 请求。可通过 Playwright.request() 获取此类别的一个实例。更多信息请参见 APIRequestContext。

方法

newContext

添加于: v1.16

apiRequest.newContext

创建 APIRequestContext 的新实例。

用法

APIRequest.newContext();
APIRequest.newContext(options);

参数

options ApiRequest.NewContextOptions *（可选）*
- setBaseURL 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
- setClientCertificates List<ClientCertificates> *（可选）*添加于: 1.46#
  - setOrigin String
    
    证书有效的精确源（Origin）。源包括 https 协议、主机名和可选端口。
  - setCertPath Path *（可选）*
    
    证书文件的路径，格式为 PEM。
  - setCert byte[] *（可选）*
    
    证书的直接值，格式为 PEM。
  - setKeyPath Path *（可选）*
    
    私钥文件的路径，格式为 PEM。
  - setKey byte[] *（可选）*
    
    私钥的直接值，格式为 PEM。
  - setPfxPath Path *（可选）*
    
    PFX 或 PKCS12 编码的私钥和证书链文件的路径。
  - setPfx byte[] *（可选）*
    
    PFX 或 PKCS12 编码的私钥和证书链的直接值。
  - setPassphrase String *（可选）*
    
    私钥的密码短语（PEM 或 PFX）。
  TLS 客户端认证允许服务器请求客户端证书并验证它。
  
  详情
  
  要使用的客户端证书数组。每个证书对象必须同时拥有 certPath 和 keyPath，或单个 pfxPath，或其对应的直接值等价项（cert 和 key，或 pfx）。如果证书已加密，可选地应提供 passphrase 属性。origin 属性应与证书有效的请求源完全匹配。
  
  注意
  在 macOS 上使用 WebKit 时，访问 localhost 将无法获取客户端证书。您可以通过将 localhost 替换为 local.playwright 来使其工作。
- setExtraHTTPHeaders Map<String, String> *（可选）*#
  
  一个包含要随每个请求发送的额外 HTTP 头部的对象。默认无。
- setFailOnStatusCode boolean *（可选）*添加于: v1.51#
  
  对于 2xx 和 3xx 以外的响应码是否抛出错误。默认情况下，所有状态码都会返回响应对象。
- setHttpCredentials HttpCredentials *（可选）*#
  - setUsername String
  - setPassword String
  - setOrigin String *（可选）*
    
    限制在特定源（origin）发送 http 凭据 (scheme://host:port).
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } *（可选）*
    
    此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。'always' - 每次 API 请求都会发送包含基本认证凭据的 Authorization 头部。'unauthorized' - 凭据仅在收到带有 WWW-Authenticate 头部的 401 (Unauthorized) 响应时发送。默认为 'unauthorized'。
  HTTP 认证的凭据。如果未指定 origin，则在收到未经授权的响应时，用户名和密码将发送给任何服务器。
- setIgnoreHTTPSErrors boolean *（可选）*#
  
  发送网络请求时是否忽略 HTTPS 错误。默认为 false。
- setMaxRedirects int *（可选）*添加于: v1.52#
  
  将自动遵循的最大请求重定向次数。如果超出此次数，将抛出错误。默认为 20。传入 0 则不遵循重定向。此设置可以单独为每个请求覆盖。
- setProxy Proxy *（可选）*#
  - setServer String
    
    用于所有请求的代理。支持 HTTP 和 SOCKS 代理，例如 http://myproxy.com:3128 或 socks5://myproxy.com:3128。短格式 myproxy.com:3128 被视为 HTTP 代理。
  - setBypass String *（可选）*
    
    可选的逗号分隔的域名列表，用于绕过代理，例如 ".com, chromium.org, .domain.com"。
  - setUsername String *（可选）*
    
    如果 HTTP 代理需要认证，则使用的可选用户名。
  - setPassword String *（可选）*
    
    如果 HTTP 代理需要认证，则使用的可选密码。
  网络代理设置。
- setStorageState String *（可选）*#
  
  使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.storageState() 或 APIRequestContext.storageState() 获取的登录信息初始化上下文。可以是保存存储状态的文件的路径，也可以是 BrowserContext.storageState() 或 APIRequestContext.storageState() 方法之一返回的值。
- setStorageStatePath Path *（可选）*添加于: v1.18#
  
  使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.storageState() 获取的登录信息初始化上下文。保存存储状态的文件的路径。
- setTimeout double *（可选）*#
  
  等待响应的最大时间（毫秒）。默认为 30000（30 秒）。传入 0 则禁用超时。
- setUserAgent String *（可选）*#
  
  在此上下文中使用的特定用户代理。

返回值

APIRequestContext #

方法​

newContext​

方法

newContext