APIRequest

公开可用于 Web API 测试的 API。此类用于创建 APIRequestContext 实例，该实例反过来可用于发送 Web 请求。此类的实例可以通过 Playwright.APIRequest 获取。有关更多信息，请参阅 APIRequestContext。

方法

NewContextAsync

添加于版本：v1.16

apiRequest.NewContextAsync

创建 APIRequestContext 的新实例。

用法

await ApiRequest.NewContextAsync(options);

参数

options ApiRequestNewContextOptions? (可选)
- BaseURL string? (可选)#
  
  诸如 ApiRequestContext.GetAsync() 之类的方法通过使用 URL() 构造函数来构建相应的 URL，从而将基本 URL 考虑在内。示例
  - baseURL: https://127.0.0.1:3000，并向 /bar.html 发送请求，结果为 https://127.0.0.1:3000/bar.html
  - baseURL: https://127.0.0.1:3000/foo/，并向 ./bar.html 发送请求，结果为 https://127.0.0.1:3000/foo/bar.html
  - baseURL: https://127.0.0.1:3000/foo（不带尾部斜杠），并导航到 ./bar.html，结果为 https://127.0.0.1:3000/bar.html
- ClientCertificates IEnumerable?<ClientCertificates> (可选)添加于版本：1.46#
  - Origin string
    
    证书有效的确切来源。来源包括 https 协议、主机名和可选的端口。
  - CertPath string? (可选)
    
    PEM 格式证书文件的路径。
  - Cert byte[]? (可选)
    
    PEM 格式证书的直接值。
  - KeyPath string? (可选)
    
    PEM 格式私钥文件的路径。
  - Key byte[]? (可选)
    
    PEM 格式私钥的直接值。
  - PfxPath string? (可选)
    
    PFX 或 PKCS12 编码的私钥和证书链文件的路径。
  - Pfx byte[]? (可选)
    
    PFX 或 PKCS12 编码的私钥和证书链的直接值。
  - Passphrase string? (可选)
    
    私钥（PEM 或 PFX）的密码。
  TLS 客户端身份验证允许服务器请求客户端证书并对其进行验证。
  
  详情
  
  要使用的客户端证书数组。每个证书对象必须同时具有 certPath 和 keyPath、单个 pfxPath 或其相应的直接值等效项（cert 和 key，或 pfx）。可选地，如果证书已加密，则应提供 passphrase 属性。 origin 属性应与证书有效的请求来源完全匹配。
  
  注意
  在 macOS 上使用 WebKit 时，访问 localhost 不会获取客户端证书。您可以通过将 localhost 替换为 local.playwright 来使其工作。
- ExtraHTTPHeaders IDictionary?<string, string> (可选)#
  
  一个包含要随每个请求一起发送的附加 HTTP 标头的对象。默认为无。
- FailOnStatusCode bool? (可选)添加于版本：v1.51#
  
  是否在 2xx 和 3xx 以外的响应代码上抛出异常。默认情况下，所有状态代码都返回响应对象。
- HttpCredentials HttpCredentials? (可选)#
  - Username string
  - Password string
  - Origin string? (可选)
    
    限制在特定来源上发送 http 凭据 (scheme://host:port).
  - Send enum HttpCredentialsSend { Unauthorized, Always }? (可选)
    
    此选项仅适用于从相应的 APIRequestContext 发送的请求，并且不影响从浏览器发送的请求。 'always' - 带有基本身份验证凭据的 Authorization 标头将随每个 API 请求一起发送。 'unauthorized' - 仅当收到带有 WWW-Authenticate 标头的 401（未授权）响应时才发送凭据。默认为 'unauthorized'。
  HTTP 身份验证的凭据。如果未指定来源，则在收到未授权响应时，用户名和密码将发送到任何服务器。
- IgnoreHTTPSErrors bool? (可选)#
  
  是否在发送网络请求时忽略 HTTPS 错误。默认为 false。
- Proxy Proxy? (可选)#
  - 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? (可选)#
  
  使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 或 ApiRequestContext.StorageStateAsync() 获取的登录信息初始化上下文。可以是保存的存储文件的路径，也可以是 BrowserContext.StorageStateAsync() 或 ApiRequestContext.StorageStateAsync() 方法之一返回的值。
- StorageStatePath string? (可选)添加于版本：v1.18#
  
  使用给定的存储状态填充上下文。此选项可用于使用通过 BrowserContext.StorageStateAsync() 获取的登录信息初始化上下文。保存的存储状态文件的路径。
- Timeout [float]? (可选)#
  
  等待响应的最长时间（以毫秒为单位）。默认为 30000（30 秒）。传递 0 以禁用超时。
- UserAgent string? (可选)#
  
  在此上下文中使用的特定用户代理。

返回值

APIRequestContext #

方法​

NewContextAsync​

方法

NewContextAsync