skills.rest
vndee
vndeeCOMMUNITY
Explore all skills by this author →
Website𝕏@DeeHuynh99GitHub

api-contract

Define and align API contracts between frontend and backend teams.

3|Updated Mar 22, 2026
Search Tags:#typescript#testing#versioning#api#openapi#breaking-changes#contract
One-click install
npx skills add https://github.com/vndee/engineering-skills --skill api-contract-vndee
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-contract
Source: https://github.com/vndee/engineering-skills/tree/main/.claude/skills/api-contract
Command: npx skills add https://github.com/vndee/engineering-skills --skill api-contract-vndee

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Defines and enforces a contract-first API process to prevent frontend-backend misalignment and integration surprises.

Core Features & Use Cases

  • OpenAPI or TypeScript contract definitions that serve as the single source of truth.
  • Parallel frontend and backend development with contract-driven tests and mocks.
  • Breaking-change detection and versioning guidance to manage API evolution.

Quick Start

Define the contract (OpenAPI spec or TypeScript types) first and share it with frontend and backend teams before implementation begins.

Frequently Asked Questions about api-contract

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

FAQPage Schema
How do I enforce API contracts between frontend and backend teams?▼

To enforce API contracts, define a single source of truth using an OpenAPI spec or TypeScript types before implementation begins. This prevents integration surprises by ensuring both teams align with the same contract definitions.

What is the best way to handle breaking changes in an API versioning strategy?▼

The best way to handle breaking changes in API versioning is to use contract-first development to detect them early. Define OpenAPI or TypeScript specs to manage API evolution and document breaking-change handling across versions.

How do I test API contracts with MSW mocks during parallel frontend and backend development?▼

You can test API contracts with MSW mocks by driving contract-first tests against the shared OpenAPI or TypeScript definitions. This allows frontend and backend teams to work in parallel using verified mock responses.

Does contract-first API development work with both OpenAPI and TypeScript?▼

Yes, contract-first API development supports both OpenAPI and TypeScript contract definitions. Either format can serve as the single source of truth to align frontend and backend teams and prevent integration surprises.

When do I need to define an API contract spec for my project?▼

You need to define an API contract spec when frontend and backend teams work in parallel or when managing versioned breaking changes. Defining the contract first prevents misalignment and integration surprises.

Related Skills

Explore More Software Engineering Skills→
ymkzymkz

openapi-first

Generate OpenAPI specs from Spring Boot for TypeScript frontend clients.

Community
Intermediate
martinffxmartinffx
39

typescript:testing

Provide Vitest, MSW, and typed mock patterns for TypeScript unit tests.

Community
Advanced
girijashankarjgirijashankarj
28

api-mock-server

Generate mock API endpoints from OpenAPI specs or TypeScript interfaces.

Community
Advanced
pacphipacphi
6

contract-testing

Automate consumer-driven contract testing for microservices and API contracts.

Community
Advanced