playwright/docs/src/api/class-apiresponseassertions.md

class: APIResponseAssertions

• langs: js, java, python

The [APIResponseAssertions] class provides assertion methods that can be used to make assertions about the [APIResponse] in the tests. A new instance of [APIResponseAssertions] is created by calling [method: PlaywrightAssertions.expectAPIResponse]:

import { test, expect } from '@playwright/test';

test('navigates to login', async ({ page }) => {
  // ...
  const response = await page.request.get('https://playwright.dev');
  await expect(response).toBeOK();
});

...
import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;

public class TestPage {
  ...
  @Test
  void navigatesToLoginPage() {
    ...
    APIResponse response = page.request().get('https://playwright.dev');
    assertThat(response).isOK();
  }
}

from playwright.async_api import Page, expect

async def test_navigates_to_login_page(page: Page) -> None:
    # ..
    response = await page.request.get('https://playwright.dev')
    await expect(response).to_be_ok()

from playwright.sync_api import Page, expect

def test_navigates_to_login_page(page: Page) -> None:
    # ..
    response = page.request.get('https://playwright.dev')
    expect(response).to_be_ok()

property: APIResponseAssertions.not

• langs: java, js

• returns: <[APIResponseAssertions]>

Makes the assertion check for the opposite condition. For example, this code tests that the response status is not successful:

await expect(response).not.toBeOK();

assertThat(response).not().isOK();

async method: APIResponseAssertions.NotToBeOK

• langs: python

The opposite of [method: APIResponseAssertions.toBeOK].

async method: APIResponseAssertions.toBeOK

• langs:
  • alias-java: isOK

Ensures the response status code is within [200..299] range.

await expect(response).toBeOK();

assertThat(response).isOK();

from playwright.async_api import expect

# ...
await expect(response).to_be_ok()

import re
from playwright.sync_api import expect

# ...
expect(response).to_be_ok()