RESTest

Spec sheet

Purpose

RESTest is a black-box testing tool that generates requests from an OpenAPI document, sends them to a REST API, and reports faults.Read 11 Oct 2026 · github.com

License

The project is distributed under the Apache License, Version 2.0.Read 11 Oct 2026 · github.com

Headquarters

Seville, SpainRead 28 Sep 2026 · github.com

Authentication

The --auth option accepts API keys, bearer tokens, and session cookies, and redacts credentials from displayed output and saved reports.Read 11 Oct 2026 · github.com

CI use

RESTest uses exit code 1 when it finds a fault, allowing build servers to fail a run on nonzero status.Read 11 Oct 2026 · github.com

Configuration

Users can customize test data with dictionaries, change a campaign plan, and configure settings through files, command-line options, or environment variables.Read 5 Oct 2026 · github.com

Customization

Users can provide dictionaries of known values and customize request plans and settings.Read 11 Oct 2026 · github.com

Fault checks

It reports HTTP 500 responses and response bodies that do not match the specification's schema.Read 11 Oct 2026 · github.com

Fault reproduction

Each reported fault includes a curl command that sends the same request again.Read 11 Oct 2026 · github.com

Implementation independent

RESTest does not inspect the API's code, so the API can be written in any language and run anywhere.Read 11 Oct 2026 · github.com

No source access required

Testing uses the API description and its responses without inspecting the API's source code.Read 5 Oct 2026 · github.com

Notable limitation

Operations requiring a file upload are listed as operations RESTest cannot test, with the reason given.Read 11 Oct 2026 · github.com

OpenAPI support

It reads OpenAPI 2.0, 3.0, and 3.1 specifications.Read 11 Oct 2026 · github.com

Reporting

RESTest writes a machine-readable report containing faults, operations, and run settings.Read 5 Oct 2026 · github.com

Reports

RESTest writes a machine-readable report.json containing faults, operations, untestable operations, and run settings.Read 11 Oct 2026 · github.com

Reproducible requests

Each reported fault includes a curl command to send the same request again.Read 5 Oct 2026 · github.com

Request strategies

Its generated requests include valid inputs, invalid inputs, mutations of accepted requests, and short sequences involving created resources.Read 11 Oct 2026 · github.com

Requirement

Building RESTest requires Java 21 or later and git; running it requires a plain Java runtime.Read 11 Oct 2026 · github.com

Requirements

Building RESTest requires Java 21 or later and git; running it requires a Java runtime.Read 5 Oct 2026 · github.com

Response checks

RESTest reports HTTP 500 responses and response bodies that do not match the documented schema.Read 5 Oct 2026 · github.com

Windows support

The installation instructions say to run RESTest on Windows from Git Bash.Read 5 Oct 2026 · github.com

Windows usage

The README says to run RESTest on Windows from Git Bash.Read 11 Oct 2026 · github.com

Plans and prices

Every RESTest plan and price →

Where Specifiction places it

• API Testing Tools#17 of 348.1