APIRequest

Exposes API that can be used for the Web API testing. This class is used for creating APIRequestContext instance which in turn can be used for sending web requests. An instance of this class can be obtained via playwright.request. For more information see APIRequestContext.

Methods​

newContext​

Creates new instances of APIRequestContext.

Usage

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

Arguments

• options Object (optional)

  • baseURL string (optional)

    Methods like apiRequestContext.get() take the base URL into consideration by using the URL() constructor for building the corresponding URL. Examples:

    • baseURL: http://localhost:3000 and sending request to /bar.html results in http://localhost:3000/bar.html
    • baseURL: http://localhost:3000/foo/ and sending request to ./bar.html results in http://localhost:3000/foo/bar.html
    • baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html

  • extraHTTPHeaders Object<string, string> (optional)

    An object containing additional HTTP headers to be sent with every request. Defaults to none.

  • httpCredentials Object (optional)

    • username string

    • password string

    • origin string (optional)

      Restrain sending http credentials on specific origin (scheme://host:port).

    Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.

  • ignoreHTTPSErrors boolean (optional)

    Whether to ignore HTTPS errors when sending network requests. Defaults to false.

  • proxy Object (optional)

    • server string

      Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.

    • bypass string (optional)

      Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".

    • username string (optional)

      Optional username to use if HTTP proxy requires authentication.

    • password string (optional)

      Optional password to use if HTTP proxy requires authentication.

    Network proxy settings.

  • storageState string | Object (optional)

    • cookies Array<Object>

      • name string

      • value string

      • domain string

      • path string

      • expires number

        Unix time in seconds.

      • httpOnly boolean

      • secure boolean

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

    • origins Array<Object>

      • origin string

      • localStorage Array<Object>

        • name string

        • value string

    Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via browserContext.storageState() or apiRequestContext.storageState(). Either a path to the file with saved storage, or the value returned by one of browserContext.storageState() or apiRequestContext.storageState() methods.

  • timeout number (optional)

    Maximum time in milliseconds to wait for the response. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

  • userAgent string (optional)

    Specific user agent to use in this context.

Returns

• Promise<APIRequestContext>