Class: Playwright::APIRequestContext

Inherits:
PlaywrightApi show all
Defined in:
lib/playwright_api/api_request_context.rb

Overview

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.

Each Playwright browser context has associated with it ‘APIRequestContext` instance which shares cookie storage with the browser context and can be accessed via [`property: BrowserContext.request`] or [`property: Page.request`]. It is also possible to create a new APIRequestContext instance manually by calling [`method: APIRequest.newContext`].

**Cookie management**

‘APIRequestContext` returned by [`property: BrowserContext.request`] and [`property: Page.request`] shares cookie storage with the corresponding `BrowserContext`. Each API request will have `Cookie` header populated with the values from the browser context. If the API response contains `Set-Cookie` header it will automatically update `BrowserContext` cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test will be logged in and vice versa.

If you want API requests to not interfere with the browser cookies you should create a new ‘APIRequestContext` by calling [`method: APIRequest.newContext`]. Such `APIRequestContext` object will have its own isolated cookie storage.

“‘python sync import os from playwright.sync_api import sync_playwright

REPO = “test-repo-1” USER = “github-username” API_TOKEN = os.getenv(“GITHUB_API_TOKEN”)

with sync_playwright() as p:

# 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 vice versa.
browser = p.chromium.launch()
context = browser.new_context(base_url="https://api.github.com")
api_request_context = context.request
page = context.new_page()

# Alternatively you can create a APIRequestContext manually without having a browser context attached:
# api_request_context = p.request.new_context(base_url="https://api.github.com")

# Create a repository.
response = api_request_context.post(
    "/user/repos",
    headers={
        "Accept": "application/vnd.github.v3+json",
        # Add GitHub personal access token.
        "Authorization": f"token {API_TOKEN}",
    },
    data={"name": REPO},
)
assert response.ok
assert response.json()["name"] == REPO

# Delete a repository.
response = api_request_context.delete(
    f"/repos/{USER}/{REPO}",
    headers={
        "Accept": "application/vnd.github.v3+json",
        # Add GitHub personal access token.
        "Authorization": f"token {API_TOKEN}",
    },
)
assert response.ok
assert await response.body() == '{"status": "ok"}'

“‘

Direct Known Subclasses

ChannelOwners::FetchRequest

Instance Method Summary collapse

Methods inherited from PlaywrightApi

#initialize, unwrap, wrap

Constructor Details

This class inherits a constructor from Playwright::PlaywrightApi

Instance Method Details

#delete(url, data: nil, failOnStatusCode: nil, form: nil, headers: nil, ignoreHTTPSErrors: nil, maxRedirects: nil, maxRetries: nil, multipart: nil, params: nil, timeout: nil) ⇒ Object

Sends HTTP(S) [DELETE](developer.mozilla.org/en-US/docs/Web/HTTP/Methods/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.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/playwright_api/api_request_context.rb', line 74

def delete(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      maxRedirects: nil,
      maxRetries: nil,
      multipart: nil,
      params: nil,
      timeout: nil)
  wrap_impl(@impl.delete(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), maxRetries: unwrap_impl(maxRetries), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
end

#dispose(reason: nil) ⇒ Object

All responses returned by [‘method: APIRequestContext.get`] and similar methods are stored in the memory, so that you can later call [`method: APIResponse.body`].This method discards all its resources, calling any method on disposed `APIRequestContext` will throw an exception.



91
92
93
 
# File 'lib/playwright_api/api_request_context.rb', line 91

def dispose(reason: nil)
  wrap_impl(@impl.dispose(reason: unwrap_impl(reason)))
end

#fetch(urlOrRequest, data: nil, failOnStatusCode: nil, form: nil, headers: nil, ignoreHTTPSErrors: nil, maxRedirects: nil, maxRetries: nil, method: nil, multipart: nil, params: nil, timeout: nil) ⇒ Object

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.

Usage

JSON objects can be passed directly to the request:

“‘python data = 

"title": "Book Title",
"body": "John Doe",

api_request_context.fetch(“example.com/api/createBook”, method=“post”, data=data) “‘

The common way to send file(s) in the body of a request is to upload them as form fields with ‘multipart/form-data` encoding, by specifiying the `multipart` parameter:

“‘python api_request_context.fetch(

"https://example.com/api/uploadScript",  method="post",
multipart={
  "fileField": {
    "name": "f.js",
    "mimeType": "text/javascript",
    "buffer": b"console.log(2022);",
  },
})

“‘



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/playwright_api/api_request_context.rb', line 124

def fetch(
      urlOrRequest,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      maxRedirects: nil,
      maxRetries: nil,
      method: nil,
      multipart: nil,
      params: nil,
      timeout: nil)
  wrap_impl(@impl.fetch(unwrap_impl(urlOrRequest), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), maxRetries: unwrap_impl(maxRetries), method: unwrap_impl(method), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
end

#get(url, data: nil, failOnStatusCode: nil, form: nil, headers: nil, ignoreHTTPSErrors: nil, maxRedirects: nil, maxRetries: nil, multipart: nil, params: nil, timeout: nil) ⇒ Object

Sends HTTP(S) [GET](developer.mozilla.org/en-US/docs/Web/HTTP/Methods/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.

Usage

Request parameters can be configured with ‘params` option, they will be serialized into the URL search parameters:

“‘python query_params = 

"isbn": "1234",
"page": "23"

api_request_context.get(“example.com/api/getText”, params=query_params) “‘



156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/playwright_api/api_request_context.rb', line 156

def get(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      maxRedirects: nil,
      maxRetries: nil,
      multipart: nil,
      params: nil,
      timeout: nil)
  wrap_impl(@impl.get(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), maxRetries: unwrap_impl(maxRetries), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
end

#head(url, data: nil, failOnStatusCode: nil, form: nil, headers: nil, ignoreHTTPSErrors: nil, maxRedirects: nil, maxRetries: nil, multipart: nil, params: nil, timeout: nil) ⇒ Object

Sends HTTP(S) [HEAD](developer.mozilla.org/en-US/docs/Web/HTTP/Methods/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.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/playwright_api/api_request_context.rb', line 175

def head(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      maxRedirects: nil,
      maxRetries: nil,
      multipart: nil,
      params: nil,
      timeout: nil)
  wrap_impl(@impl.head(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), maxRetries: unwrap_impl(maxRetries), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
end

#off(event, callback) ⇒ Object

– inherited from EventEmitter –



297
298
299
 
# File 'lib/playwright_api/api_request_context.rb', line 297

def off(event, callback)
  event_emitter_proxy.off(event, callback)
end

#on(event, callback) ⇒ Object

– inherited from EventEmitter –



291
292
293
 
# File 'lib/playwright_api/api_request_context.rb', line 291

def on(event, callback)
  event_emitter_proxy.on(event, callback)
end

#once(event, callback) ⇒ Object

– inherited from EventEmitter –



303
304
305
 
# File 'lib/playwright_api/api_request_context.rb', line 303

def once(event, callback)
  event_emitter_proxy.once(event, callback)
end

#patch(url, data: nil, failOnStatusCode: nil, form: nil, headers: nil, ignoreHTTPSErrors: nil, maxRedirects: nil, maxRetries: nil, multipart: nil, params: nil, timeout: nil) ⇒ Object

Sends HTTP(S) [PATCH](developer.mozilla.org/en-US/docs/Web/HTTP/Methods/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.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/playwright_api/api_request_context.rb', line 194

def patch(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      maxRedirects: nil,
      maxRetries: nil,
      multipart: nil,
      params: nil,
      timeout: nil)
  wrap_impl(@impl.patch(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), maxRetries: unwrap_impl(maxRetries), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
end

#post(url, data: nil, failOnStatusCode: nil, form: nil, headers: nil, ignoreHTTPSErrors: nil, maxRedirects: nil, maxRetries: nil, multipart: nil, params: nil, timeout: nil) ⇒ Object

Sends HTTP(S) [POST](developer.mozilla.org/en-US/docs/Web/HTTP/Methods/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.

Usage

JSON objects can be passed directly to the request:

“‘python data = 

"title": "Book Title",
"body": "John Doe",

api_request_context.post(“example.com/api/createBook”, data=data) “‘

To send form data to the server use ‘form` option. Its value will be encoded into the request body with `application/x-www-form-urlencoded` encoding (see below how to use `multipart/form-data` form encoding to send files):

“‘python formData = 

"title": "Book Title",
"body": "John Doe",

api_request_context.post(“example.com/api/findBook”, form=formData) “‘

The common way to send file(s) in the body of a request is to upload them as form fields with ‘multipart/form-data` encoding. Use `FormData` to construct request body and pass it to the request as `multipart` parameter:

“‘python api_request_context.post(

"https://example.com/api/uploadScript'",
multipart={
  "fileField": {
    "name": "f.js",
    "mimeType": "text/javascript",
    "buffer": b"console.log(2022);",
  },
})

“‘



249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/playwright_api/api_request_context.rb', line 249

def post(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      maxRedirects: nil,
      maxRetries: nil,
      multipart: nil,
      params: nil,
      timeout: nil)
  wrap_impl(@impl.post(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), maxRetries: unwrap_impl(maxRetries), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
end

#put(url, data: nil, failOnStatusCode: nil, form: nil, headers: nil, ignoreHTTPSErrors: nil, maxRedirects: nil, maxRetries: nil, multipart: nil, params: nil, timeout: nil) ⇒ Object

Sends HTTP(S) [PUT](developer.mozilla.org/en-US/docs/Web/HTTP/Methods/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.



268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/playwright_api/api_request_context.rb', line 268

def put(
      url,
      data: nil,
      failOnStatusCode: nil,
      form: nil,
      headers: nil,
      ignoreHTTPSErrors: nil,
      maxRedirects: nil,
      maxRetries: nil,
      multipart: nil,
      params: nil,
      timeout: nil)
  wrap_impl(@impl.put(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), maxRetries: unwrap_impl(maxRetries), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
end

#storage_state(path: nil) ⇒ Object

Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to the constructor.

Raises:

  • (NotImplementedError) 


285
286
287
 
# File 'lib/playwright_api/api_request_context.rb', line 285

def storage_state(path: nil)
  raise NotImplementedError.new('storage_state is not implemented yet.')
end