What is an API contract in this context?

An API contract is a formal agreement (often documented in api-contract.md) that defines the endpoints, request parameters, and response structures used by your application.

Does this skill help with frontend and backend coordination?

Absolutely. It acts as a bridge, allowing Claude to understand the requirements of both agents so they can build features that integrate without friction.

How does this skill improve TypeScript development?

It automatically generates shared interfaces, ensuring that the data types expected by your frontend match exactly what your backend provides, reducing runtime errors.

What trigger phrases activate this skill?

You can trigger it using phrases like 'create API', 'design endpoint', 'API scaffold', or by mentioning 'shared interfaces'.

Can I use this for existing projects?

Yes, you can invoke the skill to document existing endpoints or to standardize disparate interfaces into a single, cohesive contract.

API Contract Designer

Name: API Contract Designer
Author: Brmbobo

byBrmbobo

API Development

Standardizes API communication by generating robust TypeScript interfaces and request-response schemas for frontend and backend alignment.

About

The API Contract Designer skill streamlines the critical process of defining how frontend and backend systems interact. By automating the creation of api-contract.md files and shared TypeScript interfaces, it ensures that both sides of a development project remain perfectly synchronized. This skill is essential for developers who need to scaffold new endpoints quickly, maintain a single source of truth for data schemas, and coordinate complex logic between decoupled agents, ultimately reducing integration errors and improving code type-safety.

Key Features

Facilitates seamless coordination between frontend and backend agents
Automates endpoint design through natural language prompts
Generates standardized api-contract.md documentation
Scaffolds comprehensive request and response schemas
0 GitHub stars
Creates shared TypeScript interfaces for frontend and backend synchronization

Use Cases

Refactoring existing application interfaces to ensure strict type safety across the stack
Establishing a single source of truth for communication between decoupled engineering teams
Rapidly scaffolding new REST or GraphQL API endpoints with pre-defined types

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add brmbobo/web2podcast api-contract

For use in Claude.ai and ChatGPT

Download Skill

GitHub