Repository files navigation

The Java implementation to access theZAP API. For more informationabout ZAP consult the (main)ZAP project.

This project produces the libraryzap-clientapi, which contains the Java implementation to access the ZAP API.

The latest released versions can be downloaded from theReleases page.

Or, if using a dependency management tool, for exampleMaven orGradle, thezap-clientapi librarycan be obtained fromMaven Central with following coordinates:

• GroupId:org.zaproxy
• ArtifactId:zap-clientapi
• Version:1.16.0

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

For help using ZAP API refer to:

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

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

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 thebuild/libs directoryof each subproject.

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.