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/1. For more information
see APIRequestContext.
Since Playwright 1.16.
The examples alias the modules they use (alias Playwright.{Locator, Page}).
Summary
Types
Options of new_context/2, see its docs.
A APIRequest handle. Compare handles with ==, their fields are internal.
Functions
Creates new instances of APIRequestContext.
Like new_context/2, but returns the value and raises on error.
Types
@type new_context_options() :: [ base_url: String.t(), client_certificates: [ %{ :origin => String.t(), optional(:certPath) => String.t(), optional(:cert) => binary(), optional(:keyPath) => String.t(), optional(:key) => binary(), optional(:pfxPath) => String.t(), optional(:pfx) => binary(), optional(:passphrase) => String.t() } ], extra_http_headers: %{optional(String.t()) => String.t()}, fail_on_status_code: boolean(), http_credentials: %{ :username => String.t(), :password => String.t(), optional(:origin) => String.t(), optional(:send) => String.t() } | [ %{ :username => String.t(), :password => String.t(), optional(:origin) => String.t(), optional(:send) => String.t() } ], ignore_https_errors: boolean(), max_redirects: integer(), proxy: %{ :server => String.t(), optional(:bypass) => String.t(), optional(:username) => String.t(), optional(:password) => String.t() }, storage_state: String.t() | map(), timeout: number() | :infinity, user_agent: String.t() ] | %{ optional(:base_url) => String.t(), optional(:client_certificates) => [ %{ :origin => String.t(), optional(:certPath) => String.t(), optional(:cert) => binary(), optional(:keyPath) => String.t(), optional(:key) => binary(), optional(:pfxPath) => String.t(), optional(:pfx) => binary(), optional(:passphrase) => String.t() } ], optional(:extra_http_headers) => %{optional(String.t()) => String.t()}, optional(:fail_on_status_code) => boolean(), optional(:http_credentials) => %{ :username => String.t(), :password => String.t(), optional(:origin) => String.t(), optional(:send) => String.t() } | [ %{ :username => String.t(), :password => String.t(), optional(:origin) => String.t(), optional(:send) => String.t() } ], optional(:ignore_https_errors) => boolean(), optional(:max_redirects) => integer(), optional(:proxy) => %{ :server => String.t(), optional(:bypass) => String.t(), optional(:username) => String.t(), optional(:password) => String.t() }, optional(:storage_state) => String.t() | map(), optional(:timeout) => number() | :infinity, optional(:user_agent) => String.t() }
Options of new_context/2, see its docs.
@type t() :: %Playwright.APIRequest{ conn: term(), guid: term(), initializer: term(), table: term(), type: term() }
A APIRequest handle. Compare handles with ==, their fields are internal.
Functions
@spec new_context(t(), new_context_options()) :: {:ok, Playwright.APIRequestContext.t()} | {:error, Playwright.error()}
Creates new instances of APIRequestContext.
Since Playwright 1.16.
Options
:base_url(String.t/0) - Methods likePlaywright.APIRequestContext.get/3take the base URL into consideration by using theURL()constructor for building the corresponding URL. Examples:- baseURL:
http://localhost:3000and sending request to/bar.htmlresults inhttp://localhost:3000/bar.html - baseURL:
http://localhost:3000/foo/and sending request to./bar.htmlresults inhttp://localhost:3000/foo/bar.html - baseURL:
http://localhost:3000/foo(without trailing slash) and navigating to./bar.htmlresults inhttp://localhost:3000/bar.html
- baseURL:
:client_certificates(list ofmap/0) - Since Playwright 1.46. TLS Client Authentication allows the server to request a client certificate and verify it.Details
An array of client certificates to be used. Each certificate object must have either both
certPathandkeyPath, a singlepfxPath, or their corresponding direct value equivalents (certandkey, orpfx). Optionally,passphraseproperty should be provided if the certificate is encrypted. Theoriginproperty should be provided with an exact match to the request origin that the certificate is valid for.Client certificate authentication is only active when at least one client certificate is provided. If you want to reject all client certificates sent by the server, you need to provide a client certificate with an
originthat does not match any of the domains you plan to visit.Note
When using WebKit on macOS, accessing
localhostwill not pick up client certificates. You can make it work by replacinglocalhostwithlocal.playwright.:origin- Exact origin that the certificate is valid for. Origin includeshttpsprotocol, a hostname and optionally a port.:certPath- Path to the file with the certificate in PEM format.:cert- Direct value of the certificate in PEM format.:keyPath- Path to the file with the private key in PEM format.:key- Direct value of the private key in PEM format.:pfxPath- Path to the PFX or PKCS12 encoded private key and certificate chain.:pfx- Direct value of the PFX or PKCS12 encoded private key and certificate chain.:passphrase- Passphrase for the private key (PEM or PFX).
:extra_http_headers(%{optional(String.t()) => String.t()}) - An object containing additional HTTP headers to be sent with every request. Defaults to none.:fail_on_status_code(boolean/0) - Since Playwright 1.51. Whether to fail on response codes other than 2xx and 3xx. By default response object is returned for all status codes.:http_credentials(map/0| list ofmap/0) - Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.Pass an array to use different credentials for different origins. The first entry that matches the request origin is used, and entries with no origin match any request.
:username:password:origin- Restrain sending http credentials on specific origin (scheme://host:port).:send- This option only applies to the requests sent from correspondingAPIRequestContextand does not affect requests sent from the browser.'always'-Authorizationheader with basic authentication credentials will be sent with the each API request.'unauthorized- the credentials are only sent when 401 (Unauthorized) response withWWW-Authenticateheader is received. Defaults to'unauthorized'.
:ignore_https_errors(boolean/0) - Whether to ignore HTTPS errors when sending network requests. Defaults tofalse.:max_redirects(integer/0) - Since Playwright 1.52. Maximum number of request redirects that will be followed automatically. The call fails if the number is exceeded. Defaults to20. Pass0to not follow redirects. This can be overwritten for each request individually.:proxy(map/0) - Network proxy settings.:server- Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for examplehttp://myproxy.com:3128orsocks5://myproxy.com:3128. Short formmyproxy.com:3128is considered an HTTP proxy.:bypass- Optional comma-separated domains to bypass proxy, for example".com, chromium.org, .domain.com".:username- Optional username to use if HTTP proxy requires authentication.:password- Optional password to use if HTTP proxy requires authentication.
:storage_state(String.t/0|map/0) - Populates context with given storage state. This option can be used to initialize context with logged-in information obtained viaPlaywright.BrowserContext.storage_state/2orPlaywright.APIRequestContext.storage_state/2. Either a path to the file with saved storage, or the value returned by one ofPlaywright.BrowserContext.storage_state/2orPlaywright.APIRequestContext.storage_state/2methods.:cookies:name:value:domain:path:expires- Unix time in seconds.:httpOnly:secure:sameSite
:origins:origin:localStorage:name:value
:timeout(number/0|:infinity) - Maximum time in milliseconds to wait for the response. Defaults to30000(30 seconds). Pass0to disable timeout.In Elixir,
:infinityis the same as0: no timeout.:user_agent(String.t/0) - Specific user agent to use in this context.
@spec new_context!(t(), new_context_options()) :: Playwright.APIRequestContext.t()
Like new_context/2, but returns the value and raises on error.