Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Codecov LintCheck Examples Build and Test Package Downloads Per Month PyPI version Discord OpenSSF Scorecard

A library 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!

Contents

Quick Start

Requirements

How to install

$ pip install scanapi

Install with pipx (isolated CLI)

If pip install scanapi collides with the dependencies in your project's environment, install it with pipx instead. pipx gives ScanAPI its own virtual environment and still puts the scanapi command on your PATH:

$ pipx install scanapi

This is the recommended path when you want ScanAPI as a standalone CLI rather than a project dependency.

Basic Usage

You will need to write the API's specification and save it as a YAML or JSON file. For example:

endpoints:
  - name: scanapi-demo # The API's name of your API
    path: http://demo.scanapi.dev/api/v1 # The API's base url
    requests:
      - name: list_all_users # The name of the first request
        path: users/ # The path of the first request
        method: get # The HTTP method of the first request
        tests:
          - name: status_code_is_200 # The name of the first test for this request
            assert: ${{ response.status_code == 200 }} # The assertion

And run the scanapi command

$ scanapi run <file_path>

Then, the lib will hit the specified endpoints and generate a scanapi-report.html file with the report results.

An overview screenshot of the report. A screenshot of the report showing the request details.

Documentation

The full documentation is available at scanapi.dev

Tutorial

Get started with ScanAPI by following our step-by-step tutorial.

Examples

You can find complete examples at scanapi/examples!

This tutorial helps you to create integration tests for your REST API using ScanAPI

Watch the video

Dependency Management

ScanAPI aims to minimize dependency conflicts and ensure a smooth developer experience. Most dependencies are specified as compatible version ranges to allow flexibility and avoid unnecessary conflicts. However, a few dependencies are strictly pinned for stability:

  • MarkupSafe==3.0.3: Pinned to the latest version for security and compatibility. Relax if future versions are verified safe.
  • pytest-freezegun==0.4.2: This package is unmaintained and only 0.4.2 is available. Strict pin is required for test stability.
  • requests-mock==1.12.1: Pinned to the latest version for compatibility. Relax if future versions are verified safe.

All other dependencies use safe version ranges (e.g., >=X.Y,<X+1.0) to reduce the likelihood of dependency conflicts. If you encounter issues with dependency installation, please open an issue or PR.

Dependency updates are regularly reviewed to ensure compatibility with supported Python versions and CI stability.

Contributing

Collaboration is super welcome! Check out our contribution guide to get started. Every little bit of help counts! Feel free to create new GitHub issues and interact here.

Let's build it together 🚀🚀

❤️ Contributors

contributors

Made with contrib.rocks.

Supporters Through Time

Metadata

Release files for scanapi 2.13.4.dev7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scanapi 2.13.4.dev7
File Size Uploaded Provenance Actions
scanapi-2.13.4.dev7.tar.gz 38.2 kB Without provenance Details for scanapi-2.13.4.dev7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for scanapi 2.13.4.dev7
File Interpreter ABI Platform Actions
scanapi-2.13.4.dev7-py3-none-any.whl Python 3 none any Details for scanapi-2.13.4.dev7-py3-none-any.whl

Total release size: 80.2 kB

Release files / scanapi-2.13.4.dev7.tar.gz

Download URL scanapi-2.13.4.dev7.tar.gz
Size 38.2 kB
Tags Source
SHA-256 checksum
How to use checksums
27a3cfe705c446ccc932ca290a52fa10f210e59bf226ab71cbfa6a8f8c6b2691
BLAKE2b-256 checksum
How to use checksums
49f309e146ffbcecf4a560798234c529878251d65ec0d44948b7d76e9ffedefd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / scanapi-2.13.4.dev7-py3-none-any.whl

Download URL scanapi-2.13.4.dev7-py3-none-any.whl
Size 42.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
01d305542406e682f7ccd96c60729e1efa7b614e975b70e4d04814ea78c36dbb
BLAKE2b-256 checksum
How to use checksums
7e200b18f9ef431c41c0db408d085fd515e26897855e3ccd09c20987fcd69681
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.8 {"installer":{"name":"uv","version":"0.13.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for scanapi 2.13.4.dev7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page