AddOnDevelopment

Add-on Development

This page gives an overview of the process of developing an add-on in the zap-extensions repository and getting it published to marketplace. Please get in touch through the ZAP developer group to give us a brief overview of your add-on.

Note: The add-on does not need to be added to zap-extensions repository to be published to marketplace, it can be developed in other repositories (GitHub or elsewhere). You can raise an issue in zaproxy to request it to be published.

Implementation

Not surprisingly the first thing to do (apart from deciding what to implement) is to create the first version of your add-on.

For help with that see:

• Add-on Structure
• Building ZAP
• Extending ZAP
• ZAP Add-ons
• ZAP Internal Details

Alpha version

Once you have something you would like to publish you should open a pull request adding the add-on.

The add-on will be reviewed just to check basic things like:

• It builds(!)
• It loads as an add-on in the latest released version of ZAP
• It doesn't do anything obviously bad

As long as it passes those criteria then it will be released and available to install from within ZAP.

It is strongly recommended that your add-on provides help which can be integrated into the ZAP Help file. This is invaluable to users and means we can easily include information about your add-on in this wiki. The ZAP team can provide help and assistance with this.

You may continue to develop your add-on while its in the alpha status. If and when you would like another alpha version published let us know via the dev group - this will not happen automatically.

Beta version

There are additional requirements for add-ons to achieve beta status.

If and when you think your add-on is ready to be promoted to beta status then let us know via the dev group

It will then be reviewed, and when it has passed the review you will be able to promote it.

Again, let us know when it is ready to be published (and republished if relevant).

Release version

Again, there are additional requirements for add-ons to achieve release status.

If and when you think your add-on is ready to be promoted to release status then let us know via the dev group

It will then be reviewed, and when it has passed the review you will be able to promote it.

Again, let us know when it is ready to be published (and republished if relevant).