# Contract Auditor

> Finds where an API's code, its OpenAPI spec and its published docs disagree, and proves each finding with a test that runs against the handler. Go, TypeScript, Python and Laravel.

- [Introduction](https://contract-auditor.mintlify.app/introduction.md): Find where your API's code, spec and docs disagree. With proof.
- [Quickstart](https://contract-auditor.mintlify.app/quickstart.md): One command sets it up. There is nothing to configure by hand.
- [GitHub Actions](https://contract-auditor.mintlify.app/github-actions.md): Run the auditor on every pull request. The minimum setup needs no API key.
- [Results](https://contract-auditor.mintlify.app/results.md): Measured against injected drift with known ground truth.
- [How it works](https://contract-auditor.mintlify.app/how-it-works.md): What happens at each stage, and which parts use a model.
- [The verification gate](https://contract-auditor.mintlify.app/verification-gate.md): A claim is confirmed only if the test asserting the spec fails.
- [What counts as drift](https://contract-auditor.mintlify.app/drift-catalogue.md): The 12 failures the auditor is measured against, and the 4 refactors it must ignore.
- [API keys and secrets](https://contract-auditor.mintlify.app/secrets.md): Where each credential comes from, how to set it in GitHub Actions, and what turns on when you do.
- [Notifications](https://contract-auditor.mintlify.app/notifications.md): Push verified drift to Slack or Telegram from CI.
- [Command reference](https://contract-auditor.mintlify.app/cli.md): Every entry point, and what it costs.