Code Monkey home page Code Monkey logo

zap-api-python's Introduction

ZAP Python API

Version License

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

How to Obtain

The latest released version can be downloaded from the https://pypi.python.org/pypi/zaproxy using:

pip install zaproxy

Getting Help

For help using the ZAP API, refer to:

Issues

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

Updating the Generated Files

Most of the API code is generated from the ZAP java source code.

To regenerate the API code you will need the repos zaproxy and zap-extensions checked out at the same level as this one.

You should typically generate the core API calls from the latest release tag e.g.:

cd zaproxy
git fetch upstream -t
git checkout tags/v2.13.0
./gradlew generatePythonApiEndpoints
cd ..

The add-on APIs can be generated from the zap-extensions main branch:

cd zap-extensions
git pull upstream main
./gradle generatePythonZapApiClientFiles --continue
cd ..

The above commands will update the files in src/zapv2.

If any new files are created then they should be manually added to src/zapv2/__init__.py as per the existing files.

Note that you should also update the CHANGELOG.md file to state whatever has been changed.

zap-api-python's People

Contributors

1azunna avatar dependabot-preview[bot] avatar dependabot[bot] avatar jj avatar kingthorin avatar nate-thegrate avatar psiinon avatar ricekot avatar thc202 avatar tnir avatar woolworths avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.