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