Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

RESTest

github.com

  • Free plan
  • Windows
  • Linux
  • Self-hosted
7.4 Club score Visit github.com

What RESTest is

RESTest is a free, open-source black-box tool for testing REST APIs from OpenAPI documents. It reads OpenAPI 2.0, 3.0, and 3.1 descriptions, generates requests, checks responses, and reports faults without inspecting source code. Generated cases can use valid or invalid inputs, mutate accepted requests, and run short sequences involving created resources. RESTest flags HTTP 500 responses and response bodies that fail the documented schema. Every reported fault includes a curl command for repeating the request. Users can provide dictionaries, adjust campaign plans, and configure settings through files, command-line options, or environment variables. API keys, bearer tokens, and session cookies are accepted, with credentials redacted in reports and saved output. Machine-readable reports include faults, operations, untestable operations, and run settings. CI exit codes can fail builds when faults appear. Building requires Java 21 or later and git.

Who it suits

It suits developers and QA teams testing REST APIs from OpenAPI definitions without source access. CI users can use its exit codes and machine-readable reports.

Good to know, and what to watch

  • Supports OpenAPI 2.0, 3.0, and 3.1
  • Reproduces faults with curl commands
  • Redacts credentials in saved output
  • Supports continuous-integration failure checks
  • Apache License 2.0
  • Building requires Java 21 or later and git
  • Windows use requires Git Bash
  • Version 2.0 cannot use RESTest 1.x files

RESTest

Free

Open source

The verdict

RESTest provides configurable, implementation-independent API testing with reproducible fault reports. Its Java build requirements and version-2 incompatibility matter when adding it to existing workflows.

What the maker publishes

Authentication
The command line accepts API keys, bearer tokens, and session cookies, and redacts credentials in reports and saved output. source
Authentication
The --auth option accepts API keys, bearer tokens, and session cookies, and redacts credentials from displayed output and saved reports. source
CI use
The manual covers using RESTest in continuous integration, and its exit codes can make a build fail when faults are found. source
CI use
RESTest uses exit code 1 when it finds a fault, allowing build servers to fail a run on nonzero status. source
Configuration
Users can customize test data with dictionaries, change a campaign plan, and configure settings through files, command-line options, or environment variables. source
Customization
Users can provide dictionaries of known values and customize request plans and settings. source
Fault checks
It reports HTTP 500 responses and response bodies that do not match the specification's schema. source
Fault reproduction
Each reported fault includes a curl command that sends the same request again. source
Headquarters
Seville, Spain source
Implementation independent
RESTest does not inspect the API's code, so the API can be written in any language and run anywhere. source
License
The README states that RESTest is distributed under Apache License 2.0. source
License
The project is distributed under the Apache License, Version 2.0. source
No source access required
Testing uses the API description and its responses without inspecting the API's source code. source
Notable limitation
From version 2.0, RESTest is a complete rewrite and is incompatible with RESTest 1.x files, commands, and reports. source
Notable limitation
Operations requiring a file upload are listed as operations RESTest cannot test, with the reason given. source
OpenAPI support
It reads OpenAPI versions 2.0, 3.0, and 3.1. source
OpenAPI support
It reads OpenAPI 2.0, 3.0, and 3.1 specifications. source
Purpose
RESTest is a black-box tool that generates requests from an OpenAPI document, tests a REST API, checks responses, and reports faults. source
Purpose
RESTest is a black-box testing tool that generates requests from an OpenAPI document, sends them to a REST API, and reports faults. source
Reporting
RESTest writes a machine-readable report containing faults, operations, and run settings. source
Reports
RESTest writes a machine-readable report.json containing faults, operations, untestable operations, and run settings. source
Reproducible requests
Each reported fault includes a curl command to send the same request again. source
Request strategies
Its generated requests include valid inputs, invalid inputs, mutations of accepted requests, and short sequences involving created resources. source
Requirement
Building RESTest requires Java 21 or later and git; running it requires a plain Java runtime. source

Checked against the maker's pages on 11 Oct 2026.