Introduction
Welcome to Plyson, a declarative API testing framework built on top of Playwright.
Plyson is a framework designed to make API testing simple, scalable, and maintainable by using a declarative, JSON-driven approach. Instead of writing complex scripts, you define your tests as data.
Why Plyson?
- JSON-Driven: Write tests in a format that everyone can understand and that machines can easily generate.
- Built on Playwright: Leverages the power and reliability of Playwright's API testing capabilities.
- Dynamic Data: Built-in support for variables and generators (via Faker.js).
- Intellisense Support: Fully typed JSON schemas give you autocompletion and validation in your IDE.
Getting Started
If you're new to Plyson, we recommend starting with the installation guide.
Installation
Set up your first Plyson project in minutes.
AI Skills
Accelerate test generation with AI-powered skills.
Project Structure
Understand the folder hierarchy and conventions.
Environments
Manage different API stages like Dev and Staging.
Running & Reporting
Analyze results with Playwright's dashboard.
JSON Reference
Looking for the exact syntax of a specific field? Our reference guide covers everything from project configuration to detailed test step options.
Project Config
Detailed project.json field reference.
Test Suites
Top-level suite configuration guide.
Requests
HTTP methods, payloads, and autoFill.
Responses
Assertions and data extraction.
Operators
Complete list of all assertion operators.
Handlers
TypeScript escape hatches for complex logic.
Actions
Custom TypeScript logic as standalone test steps.
Dynamic Data
Dynamic data via $gen operators.