Available Guides

Getting Started

Optimizing for Maximum Bug Detection

Configure Schemathesis for thorough testing when preparing for production releases or conducting security assessments.

Authentication

Set up authentication for APIs that require credentials. Covers static tokens, dynamic JWT refresh, and endpoint-specific auth strategies.

Adding Schema Validation to Existing Tests

Validate API responses against your schema in existing test suites without using Schemathesis for data generation.

Integration

CI/CD Integration

Integrate Schemathesis into automated testing pipelines. Includes GitHub Actions, GitLab CI configurations, and reporting best practices.

Testing Python Web Applications

Test Flask, FastAPI, and other Python web apps directly without network overhead.

Customization

Custom Media Types

Generate valid binary content like PDFs or images when your API accepts specialized file formats.

Custom Serializers

Transform test data into non-JSON formats like CSV, MessagePack, or XML for APIs that expect alternative serialization.

GraphQL Custom Scalars

Configure domain-specific scalar types so Schemathesis generates appropriate test data for emails, phone numbers, or custom IDs.

Extending Schemathesis

Customize data generation and validation through hooks, custom checks, and format strategies.

Extending CLI

Add custom command-line options and event handlers for integration with external tools.

Advanced Testing

Customizing Stateful Testing

Configure authentication, data initialization, and scenario setup for stateful API testing workflows.

Using Hypothesis Strategies

Combine Schemathesis with custom Hypothesis strategies or use Schemathesis strategies in other testing frameworks.

Targeted Testing

Use property-based testing strategies to find performance issues and edge cases by directing test generation toward specific goals.