RESTest

What RESTest is

RESTest is a free, open-source black-box tool that generates requests from OpenAPI documents, exercises REST APIs, checks responses, and reports faults. It reads OpenAPI 2.0, 3.0, and 3.1 without inspecting the API’s source code, so the API can be implemented in any language and run anywhere. Generated requests can use valid and invalid inputs, mutate accepted requests, and make short sequences involving created resources. RESTest flags HTTP 500 responses and response bodies that do not match the documented schema. Every reported fault includes a curl command for repeating the request. Users can provide value 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 from reports and saved output. A machine-readable report.json records faults, operations, untestable operations, and run settings. Continuous integration use is documented, including exit codes that fail builds when faults are found. Building requires Java 21 or later and git; Windows use is documented through Git Bash.