Overview (RestReplay 1.0.27 API)

Packages
Package	Description
org.dynamide.interpreters
org.dynamide.restreplay
org.dynamide.restreplay.mutators
org.dynamide.restreplay.server
org.dynamide.util

RestReplay automates REST API testing via configuration files and scripts, which can call methods of this API. This Java API is documented for those who need:

Property-name access to simple request or response values
XPath filtering of response XML
JsonPath filtering of response JSON
Automation of test cases or test suites
Programmatic (java) control of REST resource cleanup
Programmatic (java) control of how RestReplay orders tests and testGroups

Main classes:

Main - Main class
Master - represents a Master file from the configuration.
RestReplay - represents a control file from the test and testGroup configuration.
RunOptions - A control file block of Admin configuration parameters.
ServiceResult - A java object representing all state (request/response/validation) from a service request.
RestReplayReport - Report generator for the three output formats: All-in-one-html, JSON database, and CLI output.

Entry to these classes is usually through our CLI, which is handled by the class Main.

If you need a custom installation, you can look at how we wire our self-test, which is in the test branch of our code on github, through the Maven surefire plugin. See org.dynamide.restreplay.RestReplaySelfTest, and the configurable examples in src/test/ such as org.dynamide.restreplay.RestReplayMasterTest and org.dynamide.restreplay.RestReplayDevTest.

Please visit our Documentation page.