scanapi

Automated Integration Testing and Live Documentation for your API

Funding Links: https://github.com/sponsors/scanapi

Name: ScanAPI
Location: World
Kind: organization
Followers: 19
Following: 0
Total stars: 1437
Repositories count: 10
Created at: 2022-11-16T06:07:32.444Z
Updated at: 2024-10-29T17:11:08.879Z
Last synced at: 2024-10-29T17:11:08.879Z

GitHub Sponsors Profile

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;