Created by: camilamaia
What is this Python project?
A framework for your API that provides:
- Automated Integration Testing
- Automated Live Documentation
Given an API specification, written in YAML/JSON format, ScanAPI hits the specified endpoints, runs the test cases, and generates a detailed report of this execution - which can also be used as the API documentation itself.
With almost no Python knowledge, the user can define endpoints to be hit, the expected behavior for each response and will receive a full real-time diagnostic report of the API!
Website Main Repo Content created by the community
What's the difference between this Python project and similar ones?
- 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.
--
Anyone who agrees with this pull request could submit an Approve review to it.