Repository navigation
RESTest 2.5.0 is easier to reach: jbang installs it on macOS, Linux and Windows and fetches a Java for it, every archive carries a skill that teaches a coding agent to use it, and it has a website, with its documentation and a showcase of what each version finds on real APIs. The command line, its exit codes, plans, dictionaries, settings and both reports are the same as in 2.4.0.
What is new
- jbang, on macOS, Linux and Windows:
jbang app install restest@https://isa-group.github.io/jbang-catalog/jbang-catalog.jsoninstallsrestest, and downloads a Java for it when there is none. - A skill for coding agents: every archive carries
skills/restest/SKILL.md, which teaches an agent such as Claude Code, Codex, Copilot or Gemini CLI to run RESTest and read what it found. RESTest and coding agents gives the two sentences to tell your agent, and how to install the skill. - A website, https://isa-group.github.io/restest-site/: what RESTest is and how to start, with a coding agent, Homebrew, jbang or Docker, and how it works, with the figures and faults of a real run. The showcase and the documentation below are part of it.
- The showcase, https://isa-group.github.io/restest-site/showcase/: what each released RESTest finds on the REST APIs of the Web Fuzzing Dataset, a minute per API, with each API's
report.htmlone click away. 2.5.0 is the first version it shows. - The documentation at one address: https://isa-group.github.io/restest-site/docs/, with search, for the latest release, and
llms.txtbeside it, which lists the Markdown of every page for coding agents. - Installing in a few lines in the README, with what each way installs in chapter 2 of the manual; chapter 4 now shows
report.htmlas a real run draws it, in light and dark. - Fix: an API that answers in HTTP/1.0, as Python's
http.serverdoes, gets a reply read for every request.
What a run sends and checks can be tuned or switched off: see settings and switches. What RESTest does not do yet is in known limitations.
Install
With Homebrew, on macOS and Linux:
brew install isa-group/tap/restestWith jbang, on macOS, Linux and Windows:
jbang app install restest@https://isa-group.github.io/jbang-catalog/jbang-catalog.jsonWith Docker:
docker run --rm ghcr.io/isa-group/restest:2.5.0 versionWith Java 21 or later, from one of the archives below:
tar -xzf restest-2.5.0.tgz
restest-2.5.0/bin/restest versionFrom the source:
git clone --branch v2.5.0 https://github.com/isa-group/RESTest.git
cd RESTest
./mvnw -q install -DskipTests
./restest versionREADME · Manual · Reference · Website · Showcase · All changes