You must be logged in to sponsor scanapi
Become a sponsor to ScanAPI
ScanAPI
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, and 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;
Featured work
-
scanapi/scanapi
Automated Integration Testing and Live Documentation for your API
Python 1,383 -
scanapi/examples
ScanAPI examples
HTML 24 -
scanapi/github-action
Github Action for ScanAPI
Dockerfile 11 -
scanapi/vscode-extension
Provides code completion for the ScanAPI YAML specification.
TypeScript 4