Skip to main content
Restlyn

Restlyn

Gherkin-powered REST API & contract testing framework

npm versionnpm downloadsGitHub starslicense

Why Restlyn?

Gherkin → Tests

Convert feature files to executable Mocha tests without step definitions.

Data Driven

Run scenarios from CSV/JSON files and iterate rows with ease.

Schema Validation

Validate responses with JSON Schema via AJV. Auto-generate schema from live response with restlyn schema.

Retry & Tokens

Built-in retry helpers and token extraction to chain requests.

Beautiful Reports

HTML report included; optional PDF if puppeteer is installed.

Easy CLI

restlyn steps, restlyn tests, restlyn verify

Scenario Tags

Control runs with @skip, @only, @debug, @retry(2).

Mock Server

Spin up a quick mock API with restlyn mock.

Warnings & CI

Aggregated warnings JSON; exit codes for CI with --warn-as-error.

Configurable Paths

Flexible .restlynrc for features, schemas, outputs, base URLs.