api-contract-validator

Community

Sync frontend/backend types, prevent API bugs.

Authorokgoogle13
Version1.0.0
Installs0

System Documentation

What problem does it solve?

API contract mismatches between frontend (TypeScript) and backend (Pydantic) lead to runtime errors, broken features, and frustrating debugging sessions. This skill automates the detection of these inconsistencies, ensuring type safety across your fullstack application.

Core Features & Use Cases

  • Automated Type Validation: Scans TypeScript interfaces and Pydantic models to ensure type and field consistency between your frontend and backend.
  • Mismatch Detection: Identifies critical issues like field name differences (e.g., userId vs. user_id), type mismatches (e.g., string vs. int), missing fields, and optionality inconsistencies.
  • Detailed Reports & Fixes: Generates a comprehensive API_CONTRACT_VALIDATION.md report with a contract health score, detailed mismatch descriptions, and actionable code suggestions for resolution.
  • Use Case: Before a major release, run this skill to catch all potential API breaking changes or inconsistencies, ensuring a smooth deployment and preventing user-facing bugs.

Quick Start

Validate API contracts between frontend TypeScript interfaces and backend Pydantic models. Generate a report with all detected mismatches and suggested fixes.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-contract-validator
Download link: https://github.com/okgoogle13/careercopilot/archive/main.zip#api-contract-validator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.