Zap.cr

Crystal client library for ZAP (Zed Attack Proxy) API. Provides complete API coverage and high-level convenience methods for common security testing workflows.

Features

• Complete ZAP API coverage with 33 API modules
• High-level scanning workflows (full scan, spider + scan, etc.)
• Progress tracking with callbacks
• Typed Crystal interface over ZAP's REST API

Quick Example

require "zap"

client = Zap::Client.new("http://localhost:8080", "your-api-key")

# High-level: full scan (spider + ajax spider + active scan)
result = client.scan.full("http://target.com") do |phase, progress|
  puts "[#{phase}] #{progress}%"
end

# Check results
puts result  # alerts summary

Getting Started

• Installation - Add zap.cr to your project
• Quick Start - Run your first scan
• Configuration - Client options

Guide

• Scanning - Full scan, active scan, passive scan workflows
• Spidering - Traditional and Ajax spidering
• Authentication - Authenticated scanning
• Alerts - Working with scan results

API Reference

• Client - Core client class
• API Modules - All 33 API module references