Skip to main content
2026-07-29 16:01
REST API

OpenAPI Conformance Hunt

RequestValidateMedium
Try Interactive Demo

What you will learn

  • Validate responses against the published contract/schema, not just the HTTP status code
  • Catch type drift, missing required fields, and wrong status codes with property/schema assertions
  • Recognise that happy-path-only suites pass real spec violations — assert the whole shape

Description

Validate responses against a published contract and prove your schema assertions catch intentional drift (wrong type, missing field, wrong status).

Test Scenario

const okBody = await (await request.get('/api/v1/conformance')).json();
expect(typeof okBody.score).toBe('number');
expect(okBody.name).toBeDefined();

const typeDrift = await (await request.get('/api/v1/conformance?drift=type')).json();
expect(typeof typeDrift.score).toBe('string'); // your schema matcher must FAIL on this

const status = await request.get('/api/v1/conformance?drift=status');
expect(status.status()).toBe(503);
Endpoint/api/v1/conformance

Testing Tips

  • •GET ?contract=1 returns the JSON-schema-ish contract to assert every response against
  • •Each ?drift= value ships one violation: type (score as string), missing (no name), status (503)
  • •A happy-path-only test passes all of these — assert the full schema, not just status 200
// Playwright API Testing - REST
import { test, expect } from '@playwright/test';


test('REST API request', async ({ request }) => {
  const response = await request.get('/api/v1/resource');


  expect(response.ok()).toBeTruthy();
  expect(response.status()).toBe(200);


  const data = await response.json();
  expect(data).toBeDefined();
});

Challenge ID: rest-openapi-conformance

2 frameworks available

API Playground

Send requests and inspect responses

Endpoint: /api/v1/conformance

Press Enter to send