Plyson

A declarative, JSON-driven API testing framework built on top of Playwright.

Features

• Declarative Testing: Write API tests in pure JSON format.
• IDE Intellisense: Built-in JSON Schema support for autocompletion and validation in your IDE.
• Dynamic Data: Support for variables and random data generation (via Faker.js).
• Playwright Powered: Leverages Playwright's reliable HTTP execution and reporting.
• Variable Scoping: Manage variables across global, environment, suite, and case scopes.
• Custom Handlers: TypeScript escape hatches for complex logic.

Quick Start

1. Install the CLI globally

npm install -g @plyson/cli

2. Initialize a new project

npx plyson init my-tests
cd my-tests

3. Sync Project Schemas

This step is crucial to enable Intellisense and autocompletion in your IDE while writing JSON tests.

npx plyson sync-project-schemas

4. Run your tests

Run all tests in your project against the default dev environment.

npx plyson run --env dev

Documentation

For detailed information, please refer to our Documentation Site:

• Installation Guide

License

MIT