Get Started

Wire ReṼoman into your JVM project, then run your first API-Graph against a live public API.

Artifact

Maven

<dependency>
    <groupId>com.salesforce.revoman</groupId>
    <artifactId>revoman</artifactId>
    <version>0.9.14</version>
</dependency>

Bazel

"com.salesforce.revoman:revoman"

Gradle Kts

implementation("com.salesforce.revoman:revoman:0.9.14")

Minimum Java Version required = 21

Figure 1. Tech-Talk given at Open Source Conf—2023, 🎴Slide deck

A Simple Example

Here is a simple exported Postman collection and Environment JSON file, to hit a free public RESTFUL-API. You can import this metadata and manually test it through the Run collection button:

You can automate the same with ReṼoman by supplying the metadata and environment paths. The example below demonstrates the engine executing API metadata (serialized in the Postman V2 schema) directly on the JVM — the very metadata you would author for manual trials becomes an automated run:

Live include from a passing integration test → RestfulAPIDevTest.java

@Test
@DisplayName("restful-api.dev")
void restfulApiDev() {
  final var rundown =
      ReVoman.revUp( (1)
          Kick.configure()
              .templatePath(PM_COLLECTION_PATH) (2)
              .environmentPath(PM_ENVIRONMENT_PATH) (3)
              .nodeModulesPath("js")
              .off());
  assertThat(rundown.firstUnIgnoredUnsuccessfulStepReport()).isNull(); (4)
  assertThat(rundown.stepReports).hasSize(4); (5)
}

1	`revUp` is the method to call passing a configuration, built as below
2	Supply an exported Postman collection JSON file path
3	Supply an exported Postman environment JSON file path
4	Assert that the execution doesn’t have any failures
5	Run more assertions on the Rundown

Next, see Configuration for how you build that configuration through Kick.configure(), and Rundown for the structured result the engine hands back.