---

sidebar_position: 10

APIRequestContext

This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
environment or the service to your e2e test. When used on Page or a BrowserContext, this API will automatically use
the cookies from the corresponding BrowserContext. This means that if you log in using this API, your e2e test will be
logged in and vice versa.

playwright.chromium.launch do |browser|
  # This will launch a new browser, create a context and page. When making HTTP
  # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
  # it will automatically set the cookies to the browser page and vise versa.
  context = browser.new_context(base_url: 'https://api.github,com')
  api_request_context = context.request


  # Create a repository.
  response = api_request_context.post(
    "/user/repos",
    headers: {
      "Accept": "application/vnd.github.v3+json",
      "Authorization": "Bearer #{API_TOKEN}",
    },
    data: { name: 'test-repo-1' },
  )
  response.ok? # => true
  response.json['name'] # => "tes≈-repo-1"
end

delete

def delete(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      multipart: nil,
      params: nil,
      timeout: nil)

Sends HTTP(S) DELETE request and returns its
response. The method will populate request cookies from the context and update context cookies from the response. The
method will automatically follow redirects.

dispose

def dispose

All responses returned by APIRequestContext#get and similar methods are stored in the memory, so that you
can later call APIResponse#body. This method discards all stored responses, and makes
APIResponse#body throw “Response disposed” error.

fetch

def fetch(
      urlOrRequest,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      method: nil,
      multipart: nil,
      params: nil,
      timeout: nil)

Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update
context cookies from the response. The method will automatically follow redirects.

get

def get(
      url,
      failOnStatusCode: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      params: nil,
      timeout: nil)

Sends HTTP(S) GET request and returns its response. The
method will populate request cookies from the context and update context cookies from the response. The method will
automatically follow redirects.

head

def head(
      url,
      failOnStatusCode: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      params: nil,
      timeout: nil)

Sends HTTP(S) HEAD request and returns its response.
The method will populate request cookies from the context and update context cookies from the response. The method will
automatically follow redirects.

patch

def patch(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      multipart: nil,
      params: nil,
      timeout: nil)

Sends HTTP(S) PATCH request and returns its response.
The method will populate request cookies from the context and update context cookies from the response. The method will
automatically follow redirects.

post

def post(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      multipart: nil,
      params: nil,
      timeout: nil)

Sends HTTP(S) POST request and returns its response.
The method will populate request cookies from the context and update context cookies from the response. The method will
automatically follow redirects.

put

def put(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      multipart: nil,
      params: nil,
      timeout: nil)

Sends HTTP(S) PUT request and returns its response. The
method will populate request cookies from the context and update context cookies from the response. The method will
automatically follow redirects.