Verified:GitHub

api-contract-testing-pattern

Validate FastAPI routes, response schemas, and status codes against a committed OpenAPI snapshot.

Updated Apr 4, 2026

Search Tags:#pytest #fastapi #api contract testing #openapi snapshot #pydantic schema validation #route regression #api drift detection

Ready to run

npx skills add https://github.com/saintgo7/claude-skills --skill api-contract-testing-pattern

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-contract-testing-pattern
Source: https://github.com/saintgo7/claude-skills/tree/main/api-contract-testing-pattern
Command: npx skills add https://github.com/saintgo7/claude-skills --skill api-contract-testing-pattern

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) components.

What problem does it solve?

This Skill prevents FastAPI/REST APIs from silently breaking clients by validating that routes, response schemas, status codes, and OpenAPI output remain consistent with expectations.

Core Features & Use Cases

Pydantic response schema validation: Enforces exact response shapes (including forbidding extra fields) to detect schema drift and unintended field changes.
OpenAPI snapshot drift detection: Detects unintended additions/removals and method changes by comparing current /openapi.json against a committed snapshot.
Contract-style happy/error path coverage: Standardizes verification of correct status codes for auth, missing resources, and invalid credentials, beyond simple 200 OK smoke checks.
Route existence checks to stop “case 20” regressions: Fails fast when expected method/path routes are not registered after refactors or integration changes.

Quick Start

Copy the template tests into your project, update APP_IMPORT/EXPECTED_ROUTES/ResponseSchema to match your API, then run your contract test suite with pytest.

Frequently Asked Questions about api-contract-testing-pattern

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I detect API drift in FastAPI applications?▼

You detect API drift in FastAPI by comparing current response schemas and the generated openapi.json against committed snapshots. This validates route presence, status codes, and pydantic model shapes to catch unintended changes during endpoint refactors.

What is API contract testing and how does it prevent client breakage?▼

API contract testing verifies that routes, response schemas, status codes, and OpenAPI output remain consistent with expectations. It prevents silent client breakage by enforcing exact response shapes and standardizing happy and error path coverage beyond simple smoke checks.

How do I validate FastAPI response schemas with pydantic to forbid extra fields?▼

You validate FastAPI response schemas with pydantic by configuring models to forbid extra fields. This enforces exact response shapes and detects schema drift immediately when unintended fields are added to API outputs.

Does pytest work with openapi.json snapshot testing for REST APIs?▼

Yes, pytest works with openapi.json snapshot testing for REST APIs. You copy template tests into your project, update the expected routes and schemas, then run the suite to compare current OpenAPI output against committed snapshots.

Why should I check route existence in API contract tests?▼

You check route existence in API contract tests to fail fast when expected method and path routes are not registered. This stops case regressions immediately after refactors or integration changes alter endpoint availability.

What are the limitations of snapshot testing for API drift detection?▼

Snapshot testing for API drift detection requires committing and maintaining openapi.json files manually. It detects structural changes effectively but does not validate runtime data correctness or business logic within the API endpoints.