Skill

Skill: api-contract

Document a clear API contract between teams — setting expectations on endpoints, data formats, SLAs, and versioning before development begins.

Install

npx claudepluginhub devmuslim/pdm-skills --plugin pdm-cross-team-coordination

Tool Access

This skill uses the workspace's default tool permissions.

Preview

Document a clear API contract between teams — setting expectations on endpoints, data formats, SLAs, and versioning before development begins.

SKILL.md

Similar Skills

cache-components

Guides Next.js Cache Components and Partial Prerendering (PPR) with cacheComponents enabled. Implements 'use cache', cacheLife(), cacheTag(), revalidateTag(), static/dynamic optimization, and cache debugging.

cache-components

139.0k

claude-opus-4-5-migration

2 files

Migrates code, prompts, and API calls from Claude Sonnet 4.0/4.5 or Opus 4.1 to Opus 4.5, updating model strings on Anthropic, AWS, GCP, Azure platforms.

claude-opus-4-5-migration

83.2k

bmad-help

Analyzes BMad project state from catalog CSV, configs, artifacts, and query to recommend next skills or answer questions. Useful for help requests, 'what next', or starting BMad.

bmad-pro-skills

43.8k

Stats

Parent Repo Stars0

Parent Repo Forks0

Last CommitMar 9, 2026

Actions

View Source View Plugin View on GitHub View README

Skill: api-contract

Purpose

Document a clear API contract between teams — setting expectations on endpoints, data formats, SLAs, and versioning before development begins.

When to Use

When a team is building an API that another team will consume
Before integration work starts
When preventing integration surprises late in the sprint

Framework: API Contract

API Contract Template

Contract Name: [API Name] v[version] Provider Team: [Team] Consumer Teams: [Teams] Agreed Date: [Date] Review Date: [Date — e.g., before code freeze]

Base URL: https://api.example.com/v2/ Authentication: Bearer Token / API Key / OAuth2 Rate Limits: 1000 req/min per consumer

Endpoints

Method	Endpoint	Description	Response	SLA
GET	/users/{id}	Fetch user by ID	User object	< 200ms p95
POST	/orders	Create new order	Order ID	< 500ms p95
DELETE	/orders/{id}	Cancel order	204 No Content	< 200ms p95

Error Codes

Code	Meaning	Consumer Action
400	Bad request	Fix request payload
401	Unauthorized	Refresh token
404	Not found	Handle gracefully
429	Rate limited	Retry with backoff
500	Server error	Alert and retry

Versioning Policy

Breaking changes: new major version (v2 → v3), 3-month notice
Non-breaking changes: minor version, no notice required

Sandbox / Mock Mock server available at: https://mock-api.example.com/v2/

Output Format

Completed API contract document
Change log section for future updates
Suggested next command: /integration-plan or /handoff-template