Project Structure

Top-level folders and files are used to organize your test suites, environments, and custom logic.

dev.env.json

sample.test.json

project.json

variables.json

playwright.config.ts

Top-level folders

environments

Required. Contains environment-specific configurations (*.env.json) like base URLs and variables.

suites

Required. Where your declarative API test suites live (*.test.json).

schemas

Optional. Stores JSON schemas (*.schema.json) for request auto-filling and response validation.

scripts

Optional. Reusable test case fragments (*.script.json) that can be shared across suites.

handlers

Optional. TypeScript "escape hatches" (*.handler.ts) for custom logic after a request.

actions

Optional. TypeScript "actions" (*.action.ts) for custom logic as standalone test steps.

Top-level files are used to configure your project, manage global variables, and define Playwright settings.

project.json

Required. The root configuration for metadata, versioning, and global hooks.

variables.json

Optional. Global defaults for your test project.

playwright.config.ts

Required. Playwright configuration file that handles reporting and worker settings.

Now that you understand the layout, let's dive into writing your first test.

Learn how to structure a test suite and add assertions.