scanapi/scanapi

Health v2 · maintenance only

Adoption not part of the score

1579 stars · 139 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

ScanAPI is a Python CLI tool that runs automated integration tests against REST APIs using declarative YAML/JSON specifications. It hits defined endpoints, asserts expected responses, and generates detailed HTML reports that double as live API documentation.

Use cases

• test my rest api endpoints automatically
• generate api documentation from test runs
• integration testing for rest apis in ci
• chain http requests using previous responses
• write api tests in yaml without python knowledge
• produce html reports of api test executions

When to choose

• you want declarative, code-light API integration tests stored as YAML/JSON in version control
• you need living documentation generated from real API requests
• you want to chain requests and validate REST endpoints in CI/CD

When to avoid

• you need unit testing of Python code rather than HTTP API testing
• you require GraphQL, gRPC, or non-REST protocol testing
• you prefer writing tests in a full programming language with complex logic

Facets

cli-tool · maturity active

testing e2e-testing api-framework http-client documentation api-documentation testing apis developer-tools documentation web-development python cli cross-platform rest-api integration-testing yaml-spec html-report live-documentation api-testing

Member repositories

For agents

markdown · JSON · MCP: product_card(name="scanapi/scanapi")