Define contract-first REST/GraphQL APIs with versioning, error semantics, and pagination.
npx skills add https://github.com/rbaumier/skills --skill api-design-rbaumier
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/rbaumier/skills/tree/main/api-design Command: npx skills add https://github.com/rbaumier/skills --skill api-design-rbaumier
Establishes robust API design governance to ensure stable contracts, predictable error semantics, and safe evolution of public surfaces across distributed systems.
Draft a contract-first API spec for a new REST or GraphQL surface and apply uniform error handling, versioning, and pagination across endpoints.
High-intent search queries and answers about installing and using this skill.
Contract-first API design defines inputs, outputs, and boundaries before implementation to prevent drift. This approach ensures stable contracts and predictable consumer integration across REST or GraphQL surfaces by enforcing additive changes and strong validation.
Hyrum's Law states that all observable behaviors of an API will be depended upon by consumers. Interface stability mitigates this by enforcing additive changes, avoiding breaking field types, and using discriminated unions for variants to protect public surfaces.
Pagination decisions depend on data access patterns: cursor-based pagination provides predictable access for large, dynamic datasets, while offset-based pagination suits smaller, static collections. Consistent pagination across endpoints simplifies client integration.
URL and header versioning both support explicit deprecation protocols for API evolution. URL versioning offers transparent routing, while header versioning keeps endpoints clean; choose based on your routing infrastructure and consumer integration requirements.
Consistent error semantics unify error shapes and status codes to simplify client integration across distributed systems. Defining standard error payloads and response codes ensures predictable failure handling across all REST and GraphQL endpoints.
Safe API deprecation requires explicit protocols that protect consumers during evolution. Use additive changes, avoid breaking field types, and provide clear deprecation timelines to ensure interface stability while clients migrate to new versions.
Fr-e-dAnalyze project directory structures to generate architectural summaries.
ivfariasGenerate data-model.md, API contracts, and quickstart.md from a specification and constitution.
japurcellDesign stable API surfaces and module boundaries for REST, GraphQL, and inter-service contracts.
silentbalanceyhGenerate frontend page code from design specifications.
