review-api-contracts

Identify breaking changes between Express API routes, MongoDB TypeScript types, and client expectations.

Updated Apr 2, 2026
One-click install
npx skills add https://github.com/cesau78/cesau-skills --skill review-api-contracts
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-api-contracts
Source: https://github.com/cesau78/cesau-skills/tree/main/review-api-contracts
Command: npx skills add https://github.com/cesau78/cesau-skills --skill review-api-contracts

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reviews the compatibility and alignment of Express API routes and shared mongo-db TypeScript types with client expectations, helping teams catch contract drift before integration.

Core Features & Use Cases

  • Contract review: Assess routes, status codes, and request/response shapes for consistency with consumer contracts.
  • Type alignment: Validate TypeScript interfaces against MongoDB document shapes used by APIs.
  • Use Case: Before pushing changes, run a contract review to ensure no breaking changes are introduced for downstream services.

Quick Start

Run a contract review against tektonology-api and mongo-db changes to verify compatibility with client expectations.

Frequently Asked Questions about review-api-contracts

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

FAQPage Schema
How do I check for breaking API changes between Express routes and MongoDB TypeScript types?

To check for breaking API changes, review Express routes and MongoDB TypeScript types against client expectations to catch contract drift. This process validates request and response shapes, ensuring consistent typing alignment before integration.

What is API contract drift and how do I prevent it before pushing changes?

API contract drift occurs when route modifications break shared type expectations. Prevent it by running a pre-push contract review that identifies breaking changes, ensures consistent error shapes, and validates versioning implications between services and clients.

How do I validate TypeScript interfaces against MongoDB document shapes used by my APIs?

Validate TypeScript interfaces against MongoDB documents by reviewing type alignment across shared types and Express API routes. This ensures that shared TypeScript interfaces accurately reflect the MongoDB document shapes consumed by your APIs.

Can I review API contracts for Express routes without dedicated testing frameworks?

Yes, you can review API contracts by assessing Express routes, status codes, and request and response shapes directly against consumer expectations. This validates compatibility and identifies inconsistencies without requiring external testing frameworks.

What is the best way to ensure consistent error shapes across API services and clients?

The best way to ensure consistent error shapes is to perform an API contract review that identifies inconsistencies between Express routes and client expectations. This process produces actionable findings to align error formatting across services.

Why does my API integration fail after updating shared MongoDB TypeScript types?

API integration fails after updating MongoDB TypeScript types when changes introduce contract drift or breaking changes. Running a type alignment review detects mismatches between shared types and API route expectations before pushing.