yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
playwright/docs/src/api/class-apirequestcontext.md
Kian-Meng Ang 22f0723c72
docs: fix typos in docs (#16370) 
Co-authored-by: Debbie O'Brien <debs-obrien@users.noreply.github.com>
Co-authored-by: Max Schmitt <max@schmitt.mx>
2022-08-09 15:47:17 +02:00

16 KiB
Raw Blame History

class: APIRequestContext

  • since: v1.16

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.

import os
import asyncio
from playwright.async_api import async_playwright, Playwright

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

async def run(playwright: Playwright):
    # 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 = await playwright.chromium.launch()
    context = await browser.new_context(base_url="https://api.github.com")
    api_request_context = context.request
    page = await context.new_page()

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

    # Create a repository.
    response = await 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 = await 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"}'

async def main():
    async with async_playwright() as playwright:
        await run(playwright)

asyncio.run(main())

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"}'

method: APIRequestContext.createFormData

  • since: v1.23
  • langs: csharp
  • returns: <[FormData]>

Creates a new [FormData] instance which is used for providing form and multipart data when making HTTP requests.

async method: APIRequestContext.delete

  • since: v1.16
  • returns: <[APIResponse]>

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.

param: APIRequestContext.delete.url = %%-fetch-param-url-%%

  • since: v1.16

param: APIRequestContext.delete.params = %%-java-csharp-fetch-params-%%

  • since: v1.18

option: APIRequestContext.delete.params = %%-js-python-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.delete.params = %%-csharp-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.delete.headers = %%-js-python-fetch-option-headers-%%

  • since: v1.16

option: APIRequestContext.delete.data = %%-js-python-fetch-option-data-%%

  • since: v1.17

option: APIRequestContext.delete.form = %%-js-python-fetch-option-form-%%

  • since: v1.17

option: APIRequestContext.delete.form = %%-csharp-fetch-option-form-%%

  • since: v1.17

option: APIRequestContext.delete.multipart = %%-js-python-fetch-option-multipart-%%

  • since: v1.17

option: APIRequestContext.delete.multipart = %%-csharp-fetch-option-multipart-%%

  • since: v1.17

option: APIRequestContext.delete.timeout = %%-js-python-fetch-option-timeout-%%

  • since: v1.16

option: APIRequestContext.delete.failOnStatusCode = %%-js-python-fetch-option-failonstatuscode-%%

  • since: v1.16

option: APIRequestContext.delete.ignoreHTTPSErrors = %%-js-python-fetch-option-ignorehttpserrors-%%

  • since: v1.16

async method: APIRequestContext.dispose

  • since: v1.16

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 stored responses, and makes [method: APIResponse.body] throw "Response disposed" error.

async method: APIRequestContext.fetch

  • since: v1.16
  • returns: <[APIResponse]>

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.

param: APIRequestContext.fetch.urlOrRequest

  • since: v1.16
  • urlOrRequest <[string]|[Request]>

Target URL or Request to get all parameters from.

param: APIRequestContext.fetch.params = %%-java-csharp-fetch-params-%%

  • since: v1.18

option: APIRequestContext.fetch.params = %%-js-python-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.fetch.params = %%-csharp-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.fetch.method

  • since: v1.16
  • langs: js, python, csharp
  • method <[string]>

If set changes the fetch method (e.g. PUT or POST). If not specified, GET method is used.

option: APIRequestContext.fetch.headers = %%-js-python-fetch-option-headers-%%

  • since: v1.16

option: APIRequestContext.fetch.data = %%-js-python-fetch-option-data-%%

  • since: v1.16

option: APIRequestContext.fetch.form = %%-js-python-fetch-option-form-%%

  • since: v1.16

option: APIRequestContext.fetch.form = %%-csharp-fetch-option-form-%%

  • since: v1.16

option: APIRequestContext.fetch.multipart = %%-js-python-fetch-option-multipart-%%

  • since: v1.16

option: APIRequestContext.fetch.multipart = %%-csharp-fetch-option-multipart-%%

  • since: v1.16

option: APIRequestContext.fetch.timeout = %%-js-python-fetch-option-timeout-%%

  • since: v1.16

option: APIRequestContext.fetch.failOnStatusCode = %%-js-python-fetch-option-failonstatuscode-%%

  • since: v1.16

option: APIRequestContext.fetch.ignoreHTTPSErrors = %%-js-python-fetch-option-ignorehttpserrors-%%

  • since: v1.16

async method: APIRequestContext.get

  • since: v1.16
  • returns: <[APIResponse]>

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.

param: APIRequestContext.get.url = %%-fetch-param-url-%%

  • since: v1.16

param: APIRequestContext.get.params = %%-java-csharp-fetch-params-%%

  • since: v1.18

option: APIRequestContext.get.params = %%-js-python-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.get.params = %%-csharp-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.get.headers = %%-js-python-fetch-option-headers-%%

  • since: v1.16

option: APIRequestContext.get.timeout = %%-js-python-fetch-option-timeout-%%

  • since: v1.16

option: APIRequestContext.get.failOnStatusCode = %%-js-python-fetch-option-failonstatuscode-%%

  • since: v1.16

option: APIRequestContext.get.ignoreHTTPSErrors = %%-js-python-fetch-option-ignorehttpserrors-%%

  • since: v1.16

async method: APIRequestContext.head

  • since: v1.16
  • returns: <[APIResponse]>

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.

param: APIRequestContext.head.url = %%-fetch-param-url-%%

  • since: v1.16

param: APIRequestContext.head.params = %%-java-csharp-fetch-params-%%

  • since: v1.18

option: APIRequestContext.head.params = %%-js-python-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.head.params = %%-csharp-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.head.headers = %%-js-python-fetch-option-headers-%%

  • since: v1.16

option: APIRequestContext.head.timeout = %%-js-python-fetch-option-timeout-%%

  • since: v1.16

option: APIRequestContext.head.failOnStatusCode = %%-js-python-fetch-option-failonstatuscode-%%

  • since: v1.16

option: APIRequestContext.head.ignoreHTTPSErrors = %%-js-python-fetch-option-ignorehttpserrors-%%

  • since: v1.16

async method: APIRequestContext.patch

  • since: v1.16
  • returns: <[APIResponse]>

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.

param: APIRequestContext.patch.url = %%-fetch-param-url-%%

  • since: v1.16

param: APIRequestContext.patch.params = %%-java-csharp-fetch-params-%%

  • since: v1.18

option: APIRequestContext.patch.params = %%-js-python-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.patch.params = %%-csharp-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.patch.headers = %%-js-python-fetch-option-headers-%%

  • since: v1.16

option: APIRequestContext.patch.data = %%-js-python-fetch-option-data-%%

  • since: v1.16

option: APIRequestContext.patch.form = %%-js-python-fetch-option-form-%%

  • since: v1.16

option: APIRequestContext.patch.form = %%-csharp-fetch-option-form-%%

  • since: v1.16

option: APIRequestContext.patch.multipart = %%-js-python-fetch-option-multipart-%%

  • since: v1.16

option: APIRequestContext.patch.multipart = %%-csharp-fetch-option-multipart-%%

  • since: v1.16

option: APIRequestContext.patch.timeout = %%-js-python-fetch-option-timeout-%%

  • since: v1.16

option: APIRequestContext.patch.failOnStatusCode = %%-js-python-fetch-option-failonstatuscode-%%

  • since: v1.16

option: APIRequestContext.patch.ignoreHTTPSErrors = %%-js-python-fetch-option-ignorehttpserrors-%%

  • since: v1.16

async method: APIRequestContext.post

  • since: v1.16
  • returns: <[APIResponse]>

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.

param: APIRequestContext.post.url = %%-fetch-param-url-%%

  • since: v1.16

param: APIRequestContext.post.params = %%-java-csharp-fetch-params-%%

  • since: v1.18

option: APIRequestContext.post.params = %%-js-python-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.post.params = %%-csharp-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.post.headers = %%-js-python-fetch-option-headers-%%

  • since: v1.16

option: APIRequestContext.post.data = %%-js-python-fetch-option-data-%%

  • since: v1.16

option: APIRequestContext.post.form = %%-js-python-fetch-option-form-%%

  • since: v1.16

option: APIRequestContext.post.form = %%-csharp-fetch-option-form-%%

  • since: v1.16

option: APIRequestContext.post.multipart = %%-js-python-fetch-option-multipart-%%

  • since: v1.16

option: APIRequestContext.post.multipart = %%-csharp-fetch-option-multipart-%%

  • since: v1.16

option: APIRequestContext.post.timeout = %%-js-python-fetch-option-timeout-%%

  • since: v1.16

option: APIRequestContext.post.failOnStatusCode = %%-js-python-fetch-option-failonstatuscode-%%

  • since: v1.16

option: APIRequestContext.post.ignoreHTTPSErrors = %%-js-python-fetch-option-ignorehttpserrors-%%

  • since: v1.16

async method: APIRequestContext.put

  • since: v1.16
  • returns: <[APIResponse]>

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.

param: APIRequestContext.put.url = %%-fetch-param-url-%%

  • since: v1.16

param: APIRequestContext.put.params = %%-java-csharp-fetch-params-%%

  • since: v1.18

option: APIRequestContext.put.params = %%-js-python-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.put.params = %%-csharp-fetch-option-params-%%

  • since: v1.16

option: APIRequestContext.put.headers = %%-js-python-fetch-option-headers-%%

  • since: v1.16

option: APIRequestContext.put.data = %%-js-python-fetch-option-data-%%

  • since: v1.16

option: APIRequestContext.put.form = %%-js-python-fetch-option-form-%%

  • since: v1.16

option: APIRequestContext.put.form = %%-csharp-fetch-option-form-%%

  • since: v1.16

option: APIRequestContext.put.multipart = %%-js-python-fetch-option-multipart-%%

  • since: v1.16

option: APIRequestContext.put.multipart = %%-csharp-fetch-option-multipart-%%

  • since: v1.16

option: APIRequestContext.put.timeout = %%-js-python-fetch-option-timeout-%%

  • since: v1.16

option: APIRequestContext.put.failOnStatusCode = %%-js-python-fetch-option-failonstatuscode-%%

  • since: v1.16

option: APIRequestContext.put.ignoreHTTPSErrors = %%-js-python-fetch-option-ignorehttpserrors-%%

  • since: v1.16

async method: APIRequestContext.storageState

  • since: v1.16
  • returns: <[Object]>
    • cookies <[Array]<[Object]>>
      • name <[string]>
      • value <[string]>
      • domain <[string]>
      • path <[string]>
      • expires <[float]> Unix time in seconds.
      • httpOnly <[boolean]>
      • secure <[boolean]>
      • sameSite <[SameSiteAttribute]<"Strict"|"Lax"|"None">>
    • origins <[Array]<[Object]>>
      • origin <[string]>
      • localStorage <[Array]<[Object]>>
        • name <[string]>
        • value <[string]>

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

async method: APIRequestContext.storageState

  • since: v1.16
  • langs: java, csharp
  • returns: <[string]>

option: APIRequestContext.storageState.path = %%-storagestate-option-path-%%

  • since: v1.16