ScanAPI

Automated Integration Testing and Live Documentation for your API

Docs Get started

API contracts tested

Guarantee the quality of the data that is being consumed or used. Ensure that communication between services is occurring as expected. Ensure the system does, in fact, what it should do.

Nested requests

Use the response of the previous request to build the next. Making it easy to debug complex scenarios of chained requests.

Live Documentation

ScanAPI will keep your API documentation always updated. No more misinformation or outdated documentation.

Version control

Keep your API tests and docs as code. Store specs and configs in your repository, review changes via pull requests, and run everything reproducibly in CI/CD.

Beautiful Reports

Generate comprehensive, interactive HTML reports automatically with every test run.

📊 Visual test results with detailed request/response data

🎨 Fully customizable with your own Jinja templates

🔒 Hide sensitive information automatically

📋 Copy exact cURL commands to reproduce requests

Learn about reports

Powerful Integration Tests

Test your API endpoints with confidence using a simple, declarative specification syntax.

🎯 Define endpoints and expected behaviors in YAML or JSON

🔗 Chain requests and use responses to build the next

🐍 Support for environment variables, custom vars, and Python code

⚡ Get instant feedback and catch issues before production

Start testing now

GitHub Secure Open Source Fund

ScanAPI is proud to be selected as one of the 71 important open source projects in the second cohort of the GitHub Secure Open Source Fund.

This initiative supports critical open source projects in securing their supply chains and improving security practices. Being part of this program helps us deliver a more secure and reliable tool for the community.

🔐

Security First

Enhanced security measures and best practices

🛡️

Supply Chain

Securing dependencies and build processes

✨

Community Trust

Building confidence in open source software

Read the Announcement

👥

Community-driven Built by developers, for developers

🌍

Global team Contributors from all over the world

💡

All contributions welcome Code, docs, ideas, and feedback

Want to contribute?

Join our community and help make ScanAPI even better!

View on GitHub Contributing Guide

Our Supporters

We are grateful for the support of our backers over time. Their contributions have been instrumental in helping us maintain and improve ScanAPI.

Your support helps us keep the project alive and growing.

Become a Backer