Skip to content

README.md

Latest commit

 

History

History
45 lines (30 loc) · 1.47 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.47 KB

Maven Central Version

OVERLAY-JVM

JVM Library (e.g., for Java and Kotlin) to support OpenAPI Overlay transformations.

Currently supporting Overlay specs 1.1.0, and schemas/overlays in either JSON or YAML.

Working for JDK 8 and above.

Example Usage

String openApi = ...
String overlay = ...
TransformationResult tr = OverlayJVM.applyOverlay(openApi, overlay);
tr.transformedSchema; // the result of the transformation
tr.warnings; // list of warning messages, if any

Use in Maven

<dependency>
    <groupId>com.webfuzzing</groupId>
    <artifactId>overlay-jvm</artifactId>
    <version>0.2.0</version>
</dependency>

Dependencies

This library has 2 main dependencies:

  • Jackson: to be able to parse JSON/YAML files.
  • SnackJson: for handling RFC 9535 JsonPath, and for DOM manipulation.

Project Maintenance

This is a small, relatively simple library. Apart from bug-fixing and supporting new Overlay specs when they come out, we do not expect much activity here in this project.

The main driver beyond supporting and maintaining this open-source project is its use in the REST API fuzzer EvoMaster. As long as we support EvoMaster (which has been around since 2016), we will keep supporting this library.