api-designer
api designer
What it does
- Follow REST principles (resource-oriented, proper HTTP methods)
- Use consistent naming conventions (snakecase or camelCase — pick one, apply everywhere)
- Include comprehensive OpenAPI 3.1 specification
- Design proper error responses with actionable messages (RFC 7807)
- Implement pagination for all collection endpoints
- Version APIs with clear deprecation policies
- Document authentication and authorization
Requirements & configuration
- 1. Analyze domain — Understand business requirements, data models, and client needs
Derived from the skill's own SKILL.md documentation · extracted 2026-07-23
api-designer FAQ
What does the api-designer skill do?
Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards. Follow REST principles (resource-oriented, proper HTTP methods) Use consistent naming conventions (snakecase or camelCase — pick one, apply everywhere)
What does api-designer require?
1. Analyze domain — Understand business requirements, data models, and client needs
How do I install api-designer?
Run: npx -y skills add https://github.com/jeffallan/claude-skills --skill api-designer --agent claude-code — the source lives at github.com/jeffallan/claude-skills.
Maintain api-designer?
Let people know it's listed here — add the badge (live metrics, light/dark aware) or a plain link to your README or docs.
[api-designer on getagentictools](https://getagentictools.com/skills/jeffallan-claude-skills-api-designer?ref=badge) npx agentictools info skills/jeffallan-claude-skills-api-designer The second line is the CLI lookup for this page — handy in READMEs and docs.
