Skills
.Work. You
Rest

api-contract

Community

Define a shared, precise API contract.

Software Engineering#documentation#validation#contract-design#backend-frontend#typescript-interfaces#api-contract
Authordamienlaine
Version1.0.0
Installs0

System Documentation

What problem does it solve?

The API contract defines a shared interface between backend and frontend agents, providing a single source of truth for endpoints, requests/responses, and error handling.

Core Features & Use Cases

  • Centralizes API shape in api-contract.md as the single source of truth.
  • Endpoints, request/response schemas, and error codes to align backend and frontend.
  • TypeScript interfaces to ensure type safety across teams.
  • Validation rules and clear error handling guidelines.

Quick Start

Create .claude/sprint/[N]/api-contract.md and fill in sections for Base URL, Authentication, Endpoints, TypeScript Interfaces, and Validation Rules. Use the examples in this skill as templates.

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
Download link: https://github.com/damienlaine/agentic-sprint/archive/main.zip#api-contract

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.