ScanAPI
COLLECTIVE
Open source
Fiscal Host: Open Source Collective
Automated Integration Testing and Live Documentation for your API
Contribute
Become a financial contributor.
Financial Contributions
Top financial contributors
Organizations
GitHub Sponsors
$6,096.94 USD since Jul 2025
Red Hat
$1,000 USD since Dec 2021
Individuals
1
Paula Caroline
$25 USD since Jul 2023
ScanAPI is all of us
Our contributors 6
Thank you for supporting ScanAPI.
Marcus Pereira
Core Contributor
Camila Maia
Admin
Cumbuca Dev
Admin
GitHub Sponsors
$6,097 USD
Red Hat
$1,000 USD
Paula Caroline
$25 USD
Budget
Transparent and open finances.
Credit from GitHub Sponsors to ScanAPI •
+$308.11USD
Completed
Added funds #925774
Credit from GitHub Sponsors to ScanAPI •
+$50.00USD
Completed
Added funds #906343
Credit from GitHub Sponsors to ScanAPI •
+$41.94USD
Completed
Added funds #896227
$
Today’s balance$360.05 USD
Total raised
$6,379.05 USD
Total disbursed
$6,019.00 USD
Estimated annual budget
$6,096.94 USD
About
ScanAPI is a testing framework that provides automated integration testing and live documentation for any REST API.
Given an API specification, written in YAML/JSON format, the library hits the specified endpoints, runs the test cases, and generates a detailed report of this execution - that can be also used as the API documentation itself.
With few lines, the user can define endpoints to be hit, the expected behaviors for each response, and, as a result, receives a full real-time diagnostic of the API.
Given an API specification, written in YAML/JSON format, the library hits the specified endpoints, runs the test cases, and generates a detailed report of this execution - that can be also used as the API documentation itself.
With few lines, the user can define endpoints to be hit, the expected behaviors for each response, and, as a result, receives a full real-time diagnostic of the API.
Why ScanAPI?
- It works for any REST API, doesn't matter how it was built;
- It is extremely useful for testing and documenting both owned and third-party APIs;
- It is possible to chain requests, which is essential for testing complex scenarios;
- The documentation is automatically generated, it never gets outdated;
- It is simple. The syntax is simple, and it requires almost no language-specific knowledge;
- It is extremely flexible, once pure python code is accepted in the specification;
- There is nothing in the market that does what ScanAPI does.