OWASP ZAP Java API

The Java implementation to access the OWASP ZAP API. For more information about OWASP ZAP consult the (main) OWASP ZAP project.

This project produces two libraries:

zap-clientapi, the library that contains the Java implementation to access the OWASP ZAP API;
zap-clientapi-ant, the library that contains Ant tasks that wrap functionality provided by zap-clientapi. This library depends on zap-clientapi and Ant, both should be available at runtime.

How to Obtain

The latest released versions can be downloaded from the Releases page.

Or, if using a dependency management tool, for example Maven or Gradle, the zap-clientapi library can be obtained from Maven Central with following coordinates:

GroupId: org.zaproxy
ArtifactId: zap-clientapi
Version: 1.10.0

Previous releases are also available, more details can be found in Maven Central.

Getting Help

For help using OWASP ZAP API refer to:

Examples - collection of examples using the library;
API Documentation
OWASP ZAP User Group - for asking questions

Issues

To report issues related to OWASP ZAP API, bugs and enhancements requests, use the issue tracker of the main OWASP ZAP project.

Building

This project uses Gradle to build its libraries, for example, running:

./gradlew build

in the main directory of the project will build all the libraries. The libraries will be located in the build/libs directory of each subproject.

Installing

To install the artifacts to the local Maven repository you can run the following:

./gradlew install

The installed artifacts (zap-clientapi) are then available for other (local) projects to use.

ricekot / zap-api-java