Description
api-and-interface-design is an agent skill from Addy Osmani's agent-skills collection that guides the design of stable, well-documented interfaces that are hard to misuse. The skill's aim is that the right thing is easy and the wrong thing is hard. It covers REST APIs, GraphQL schemas, module boundaries, component props, and any surface where one piece of code talks to another. It applies when designing new endpoints, defining contracts between teams or modules, creating component prop interfaces, shaping a database schema that will inform the API, and changing an existing public interface. The skill's central principle is Hyrum's Law: with enough users of an API, every observable behavior will be depended on by somebody, whatever the contract promises. That means changes to observable behavior need the same care as changes to the contract itself. The skill is listed on skills.sh, with its security audit results shown on that page. It suits engineers and agents who design or change interfaces that other code depends on.…
Highlights
- REST, GraphQL and module boundary design
- Component prop interface guidance
- Hyrum's Law applied to public behavior
- Guidance for changing existing interfaces
Ratings & Reviews
No ratings yet
Be the first to rate api-and-interface-design.
People also visit
design-an-interface
Generate multiple radically different interface designs for a module
contract-first
Coordinate frontend/backend or service-to-service work through one authoritative
network-interface-health
Diagnose interface errors, drops, CRCs, duplex mismatches, flapping
api-and-interface-design FAQ
What does the api-and-interface-design skill do?
It guides an agent through designing stable, hard-to-misuse interfaces, including REST and GraphQL APIs, module boundaries and component props.
How do I install it?
Run: npx skills add https://github.com/addyosmani/agent-skills --skill api-and-interface-design
What is Hyrum's Law in this skill?
The principle that with enough users, every observable behavior of a system will be depended on, whatever the contract promises.
When should I use it?
When designing new endpoints or boundaries, creating prop interfaces, shaping schemas that inform an API, or changing a public interface.
What security checks has it passed?
skills.sh lists three audits: Gen Agent Trust Hub Pass, Socket Pass and Snyk Pass.
What are the best api-and-interface-design alternatives?
Popular alternatives to api-and-interface-design include api-designer, design-an-interface and backend-patterns. See all api-and-interface-design alternatives