dev-api-design
CommunityDesign production-grade APIs with confidence
System Documentation
What problem does it solve?
Design and document robust, maintainable APIs so teams can ship interoperable services without ambiguity, inconsistent contracts, or operational surprises. It reduces friction across client and server teams by prescribing contract-first workflows, clear error models, versioning, auth boundaries, and operability standards so integrations are predictable and safe.
Core Features & Use Cases
- Define API contracts first (OpenAPI 3.1 / GraphQL schema / protobuf) and run breaking-change checks in CI.
- Standardize error handling with RFC 9457 Problem Details, stable error codes, and trace IDs for debuggability.
- Architect pagination, filtering, idempotency, rate limiting (token-bucket), and observability (W3C Trace Context, request IDs).
- Provide templates and full-stack examples (FastAPI, Express, Django, Spring Boot) for rapid implementation and developer docs.
- Use when designing public developer APIs, internal microservice contracts, agent-friendly endpoints, or migrating versions.
Quick Start
Request an OpenAPI 3.1 contract for a public REST orders API including JWT auth, cursor pagination, RFC 9457 error responses, and tiered rate limits.
Dependency Matrix
Required Modules
None requiredComponents
💻 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: dev-api-design Download link: https://github.com/innexar-plat/Master-Coat-Solutions/archive/main.zip#dev-api-design Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.