Star

Created With

linkSpec Overview & Basic Concepts

REST-EZ's lets you test HTTP-based APIs without code (declarative, instead of procedural). It aims to make API testing easy, free, and fast for everyone.

linkThe High-level View

suite - a yaml file that includes a list of one or more specs
spec - block that defines a request & response dialog, with optional assertions and lifecycle hooks

You can write custom JS including external JS files.

linkRequired Sections

A test suite has three required sections:

linkOptional Sections

Optional sections are:

Spec Overview & Basic Concepts The High-level View Required Sections Optional Sections

Getting Startedchevron_right

Installation Basic Usage GraphQL

Basicschevron_right

Overview Meta Config Specs

Requestchevron_right

Request Basics Headers Cookies Query Parameters Path Parameters

Payload Bodychevron_right

JSON Body Binary Data URL Encoded Form Data Multi-Part Form Data

File Uploads Auto-Retry Additional Options

Response Validationchevron_right

Assertionschevron_right

Exact Value Regular Expression Exact Value Custom JS Validator

Status Code Headers & Cookies

Bodychevron_right

Overview Exact Value Regular Expression JSON Path JSON Schema Inline JSON Schema File Swagger / Open API

Hooks & JSchevron_right

Function Typeschevron_right

JS Inline Functions JS Async Inline Functions JS Modules

Suite-Level Hookschevron_right

before_all after_all before_each after_each

Spec-Level Hookschevron_right

before_test after_test

Contextchevron_right

Suite Context Test Context Response Context

DRY & Reusing Specschevron_right

Overview Looping Yaml Anchors Run Existing Spec

Command Line Interface (CLI)chevron_right

Basics Debugging Running in Parallel Options Reporters