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

  • ExtraHTTPHeaders IDictionary?<string, string> （可选）#

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

  • HttpCredentials HttpCredentials? （可选）#

    • Username string

    • Password string

    • Origin string? （可选）

      限制在特定来源（scheme://host：port).

    • Send enum HttpCredentialsSend { Unauthorized, Always }? （可选）

      此选项仅适用于从相应的 APIRequestContext 发送的请求，不影响从浏览器发送的请求。 'always' - 每次 API 请求都会发送带有基本身份验证凭据的 Authorization 标头。 '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#