Welcome to ZAP API Documentation! The OWASP Zed Attack Proxy (ZAP) is one of the world's most popular free security tools which lets you automatically find security vulnerabilities in your web applications. ZAP also has an extremely powerful API that allows you to do nearly everything that possible via the desktop interface. This allows the developers to automate pentesting and security regression testing of the application in the CI/CD pipeline. This repository This provides example guides & API definitions for ZAP APIs.
The live demo can be viewed in the following URL.
The guidelines for contribution is available in the following page.
ZAP documentation is built using Slate. All documentation is in includes directory,
and uses Markdown text format. View the contribution guide on how to start contributing to the document.
The Open API markdown is auto generated from the openapi.yaml file and the Widdershins
node package is used to auto generate the markdown file.
# To install the widdershins package
npm i -g widdershins
# To generate the markdown file
widdershins --search false --language_tabs 'python:Python' 'java:Java' 'shell:Shell' --summary openapi.yaml source/includes/api.md