# scanapi/scanapi

Automated Integration Testing and Live Documentation for your API

Repository: https://github.com/scanapi/scanapi
Canonical: https://ross.abutalabs.com/products/scanapi
Homepage: https://scanapi.dev
Language: Python
License: MIT
License Family: permissive
Topics: python3, python-package, pypi-packages, scanapi, yaml, json, api, rest-api, testing, integration-testing, autodoc, cumbucadev
Last push: 2026-08-24T11:35:34+00:00

## Health v2 (maintenance only)
Score: 98/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 99, release rhythm 97, longevity 100
- inputs: {"age_days": 2601, "days_push": 9, "days_rel": 20, "gap_med": 9.5, "n_releases_24m": 9}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1579, forks 139 (observed 2026-08-28T04:05:06.757900+00:00)

## What it is
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
- artifact type: cli-tool
- maturity: active
- function: testing, e2e-testing, api-framework, http-client, documentation, api-documentation
- domain: testing, apis, developer-tools, documentation, web-development
- platform: python, cli, cross-platform
- tags: rest-api, integration-testing, yaml-spec, html-report, live-documentation, api-testing

## Member repositories
- scanapi/scanapi (main) score 98

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:06.757900+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:56:53.121505+00:00, confidence not recorded.
  - readme: https://github.com/scanapi/scanapi (fetched 2026-08-28T04:05:06.757900+00:00, sha 343f77f6353a)
  - homepage: https://scanapi.dev (fetched 2026-08-29T11:27:11.507921+00:00, sha 88dbebb5ad65)
  - registry_pypi: https://pypi.org/pypi/scanapi/json (fetched 2026-08-29T11:27:11.518121+00:00, sha c741dea83b1f)
- Data as of 2026-08-30T08:39:29.467469+00:00.