api-contract-modeling
CommunityDefine resilient API contracts with typed errors.
Software Engineering#typescript#openapi#zod#error-handling#fallback#api-contracts#discriminated-union
Authorluansilvadb
Version1.0.0
Installs0
System Documentation
What problem does it solve?
The task of designing API contracts where errors are treated as first-class citizens is often overlooked, leading to brittle clients and ambiguous failure modes.
Core Features & Use Cases
- Strongly typed error schemas using discriminated unions (e.g., TypeScript/Zod) that map to explicit HTTP status codes.
- OpenAPI-compatible matrices that document 4xx/5xx errors with named codes and fallback strategies.
- Guidance for idempotent mutations and resilient headers to enable safe retries and circuit-breaker patterns.
Quick Start
Design and emit an OpenAPI spec and TypeScript types for a new API endpoint with explicit error codes and retry policies.
Dependency Matrix
Required Modules
None requiredComponents
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-modeling Download link: https://github.com/luansilvadb/agoravai/archive/main.zip#api-contract-modeling 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.