@api-core/playwright

Playwright executor implementation for API-Core. This package allows you to run type-safe, contract-first API requests backed by Playwright's APIRequestContext or browser Page context.

Installation

npm install @api-core/playwright @api-core

Quick Start

import { test } from '@playwright/test';
import { createClient } from '@api-core/playwright';
import { registry } from './registry'; // Your API-Core registry

test('fetches user details', async ({ request }) => {
  const client = createClient({
    config: {
      baseURL: 'https://api.example.com',
    },
    registry,
    request, // Pass Playwright request context
  });

  const response = await client.get('users.getUser', {
    path: { id: 42 },
  });

  console.log(response.data);
});

Features

• Type-Safe API Calls: Fully typed request path parameters, query params, headers, and responses mapped from your contract registry.
• Playwright Context Integration: Seamless integration with Playwright's request fixture, browser page context, or browser context.
• Automatic Auth & Cookie Management: Retains context and headers/cookies across browser contexts.
• Production-Grade Autocomplete: Offers clean IntelliSense scoped strictly to Playwright-specific parameters (e.g. page, context, request).

Example

For a detailed test suite example, see examples/src/tests/playwright.test.ts.

API Overview

createClient(options)

Instantiates the client. The options object accepts:

• registry: The API-Core contract registry.
• config: Global configuration overrides (like baseURL).
• request: Playwright's APIRequestContext (from the request fixture).
• page: Playwright's Page instance.
• context: Playwright's BrowserContext.

License

MIT © Shanmuka Chandra Teja Anem

Contributing

Contributions are welcome! Please read the root contributing guidelines, open an issue, or submit a pull request.