api-designer
by Roy Yuen
Professional API design and review skill for REST, GraphQL, and event-driven architectures.
- Generate OpenAPI specs from resource-based data models
- Validate API designs against industry-standard naming conventions
- Map GraphQL schemas to legacy REST backend endpoints
$5
One-time purchase
Included in download
- Generate OpenAPI specs from resource-based data models
- Validate API designs against industry-standard naming conventions
- Ready for Claude Code
- Includes example output and usage patterns
See it in action
API Style: REST
Resource: /orders
POST /orders: Creates a pending order.
Request: { userId: UUID, items: Array<SKU> }
Response: 201 Created { id: UUID, status: 'pending', total: Decimal }
Error: 422 Unprocessable Entity for invalid SKUs with error_code 'INVALID_INVENTORY'.api-designer
by Roy Yuen
Professional API design and review skill for REST, GraphQL, and event-driven architectures.
$5
One-time purchase
⚡ Also available via Agensi MCP — your AI agent can load this skill on demand via MCP. Learn more →
Included in download
- Generate OpenAPI specs from resource-based data models
- Validate API designs against industry-standard naming conventions
- Ready for Claude Code
- Includes example output and usage patterns
- Instant install
See it in action
API Style: REST
Resource: /orders
POST /orders: Creates a pending order.
Request: { userId: UUID, items: Array<SKU> }
Response: 201 Created { id: UUID, status: 'pending', total: Decimal }
Error: 422 Unprocessable Entity for invalid SKUs with error_code 'INVALID_INVENTORY'.About This Skill
What it does
The API Designer skill provides a structured framework for architects and developers to build robust, scalable interfaces. It moves beyond simple endpoint sketching to cover resource modeling, lifecycle states, and contract-first documentation for REST, GraphQL, and event-driven systems.
Why use this skill
Designing an API is easy; designing a consistent API that survives internal scaling and public consumption is hard. This skill automates the architectural heavy lifting by enforcing standardized strategies for pagination, error handling, and versioning. Instead of wasting time on debating naming conventions or status codes, the agent applies industry best practices to ensure your contracts are predictable and maintainable.
Supported workflows
- Contract-First Design: Detailed modeling of resources, actions, and request/response shapes before a single line of code is written.
- API Auditing: Comprehensive reviews targeting issue severity, design risks, and backward compatibility evidence.
- Integration Planning: Defining auth boundaries and transport-independent business logic.
The Output
Expect high-density, structured design specs including endpoint summaries, auth expectations, and explicit error behaviors. For reviews, you receive a prioritized list of risks with actionable recommended fixes, ensuring your API remains stable and developer-friendly.
📖 Learn more: Best Frontend & Design Skills for Claude Code →
Use Cases
- Generate OpenAPI specs from resource-based data models
- Validate API designs against industry-standard naming conventions
- Map GraphQL schemas to legacy REST backend endpoints
- Draft async event schemas for message-driven architectures
- Automate versioning strategies for backward compatibility checks
Known Limitations
• Does not generate executable SDK code or server boilerplate. • Best suited for design-time planning, not real-time traffic monitoring. • Requires user-provided business context for optimal modeling.
How to Install
unzip api-designer.zip -d ~/.claude/skills/Reviews
No reviews yet - be the first to share your experience.
Only users who have downloaded or purchased this skill can leave a review.
Early access skill
Be the first to review this skill.
Only users who have downloaded or purchased this skill can leave a review.
Security Scanned
Passed automated security review
Permissions
No special permissions declared or detected
Claude Code, Codex, and OpenCode.
Frequently Asked Questions
Learn More About AI Agent Skills
Similar Skills
code-reviewer
Reviews your code for bugs, security vulnerabilities, logic errors, performance issues, and style violations. Organizes findings by severity and suggests fixes with code examples.
git-commit-writer
Writes conventional commit messages by analyzing your staged git changes. Detects commit type, scope, and breaking changes automatically.
readme-generator
Generates a complete, polished README.md by scanning your actual project structure, dependencies, and code.
env-doctor
Diagnoses why your project will not start. Checks runtime versions, dependencies, environment variables, databases, ports, and build artifacts systematically.