{"id":28466833,"url":"https://github.com/zaproxy/zap-api-docs","last_synced_at":"2025-10-14T10:36:40.070Z","repository":{"id":37394531,"uuid":"213366701","full_name":"zaproxy/zap-api-docs","owner":"zaproxy","description":"ZAP API Documentation","archived":false,"fork":false,"pushed_at":"2025-06-16T19:37:57.000Z","size":2977,"stargazers_count":35,"open_issues_count":6,"forks_count":27,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-07-01T01:41:47.888Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.zaproxy.org/docs/api/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zaproxy.png","metadata":{"funding":{"custom":["https://www.zaproxy.org/sponsor/"]},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-10-07T11:34:24.000Z","updated_at":"2025-06-16T12:13:09.000Z","dependencies_parsed_at":"2024-04-15T21:51:56.179Z","dependency_job_id":"81d7211c-d988-4e42-b1c1-187031a7787e","html_url":"https://github.com/zaproxy/zap-api-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zaproxy/zap-api-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fzap-api-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fzap-api-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fzap-api-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fzap-api-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zaproxy","download_url":"https://codeload.github.com/zaproxy/zap-api-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaproxy%2Fzap-api-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263091025,"owners_count":23412344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-07T07:06:06.649Z","updated_at":"2025-10-14T10:36:35.048Z","avatar_url":"https://github.com/zaproxy.png","language":"JavaScript","funding_links":["https://www.zaproxy.org/sponsor/"],"categories":[],"sub_categories":[],"readme":"\n# Introduction\n\nWelcome to ZAP API Documentation! The [Zed Attack Proxy](https://www.zaproxy.org/) (**ZAP**) \nis one of the world's most popular free security tools which lets you automatically find security vulnerabilities in your \napplications. ZAP also has an extremely powerful API that allows you to do nearly everything that possible via the desktop interface.\nThis allows the developers to automate pentesting and security regression testing of the application in the CI/CD pipeline.\nThis repository provides example guides \u0026 API definitions for ZAP APIs.\n\nThe live documentation can be viewed in the following [URL](https://zaproxy.org/docs/api/).\n\n# Contributing to the Documentation\n\nThe guidelines for contribution is available in the [following page](https://zaproxy.org/docs/api/#contributions-welcome).\nZAP documentation is built using [Slate](https://github.com/slatedocs/slate). The source files for the documentation are available \nin the `source/includes` directory. View the contribution guide on how to start contributing to the document.\n\n# Deploying\n\nTo deploy to https://zaproxy.org/\n\n1. Run `bundle install` if you have not done so before\n1. Run `bundle exec middleman build --clean`\n1. Copy the build directory to your own clone of https://github.com/zaproxy/zaproxy.github.io e.g.\n    - `cp -R build/* ../zaproxy.github.io/docs/api/`\n1. Commit and push any changes then open a PR on https://github.com/zaproxy/zaproxy.github.io\n\n# Generate OpenAPI Markdown\n\nThe OpenAPI markdown is auto generated from the `openapi.yaml` file and the [Widdershins](https://github.com/Mermade/widdershins) \nnode package is used to auto generate the markdown file.\n\n```bash\n# To install the widdershins package\nnpm install\n# To generate the markdown file\nnpm run build\n``` \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaproxy%2Fzap-api-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzaproxy%2Fzap-api-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaproxy%2Fzap-api-docs/lists"}