API Designer
Skill Verified ActiveREST and GraphQL API architect for designing robust, scalable APIs. Use when designing new APIs or improving existing ones.
To guide users in architecting robust, scalable, and maintainable REST and GraphQL APIs by providing best practices, principles, and validation tools.
Features
- Designs REST and GraphQL APIs
- Provides REST API design principles
- Offers GraphQL schema design guidance
- Covers API versioning strategies
- Details authentication and authorization methods
- Recommends rate limiting parameters
- Includes scripts for API scaffold generation and validation
Use Cases
- Designing a new API from scratch
- Reviewing and improving existing API designs
- Creating API specifications and documentation
- Ensuring API scalability, robustness, and maintainability
Non-Goals
- Implementing the actual API endpoints
- Handling runtime API requests or traffic management
- Providing tools for API testing or deployment
Workflow
- User initiates API design task.
- Skill provides guidance on REST or GraphQL principles.
- User interacts with the skill to refine API structure, endpoints, and specifications.
- User may invoke scripts to generate or validate design artifacts.
- Skill outputs refined API design documentation and best practices.
Versioning
- info:Release ManagementWhile there are no formal release tags or CHANGELOG, the commit history shows recent activity, and the installation method is tied to the `main` branch, suggesting versioning is implicitly managed by commits.
Scope
- info:Dry-run previewThe `generate_api.py` script has a `--force` flag for overwriting, but no explicit `--dry-run` option to preview file content before writing.
Practical Utility
- info:Usage examplesThe README provides basic usage examples for interacting with the skill, but the SKILL.md could benefit from more end-to-end examples demonstrating the output of the scripts and design generation.
Installation
npx skills add charon-fan/agent-playbookRuns the Vercel skills CLI (skills.sh) via npx — needs Node.js locally and at least one installed skills-compatible agent (Claude Code, Cursor, Codex, …). Assumes the repo follows the agentskills.io format.
Quality Score
VerifiedTrust Signals
Similar Extensions
API Designer
99Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.
API Design Patterns
100Comprehensive API design patterns covering REST, GraphQL, gRPC, versioning, authentication, and modern API best practices
Backend Api Design
99Design RPC-style APIs with layered architecture (Controller → Manager → Repository). Use when creating new API endpoints, designing API contracts, or reviewing API patterns.
Api Design
99REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.
Shopify Expert
99Comprehensive Shopify development expert with access to 24 official documentation files covering APIs (GraphQL Admin, Storefront, REST), app development, themes, Liquid, Hydrogen, checkout, extensions, webhooks, Functions, CLI, subscriptions, payments, and all platform features. Invoke when user mentions Shopify, e-commerce, online store, product management, orders, checkout, themes, or headless commerce.
Graphql Schema
98Guide for designing GraphQL schemas following industry best practices. Use this skill when: (1) designing a new GraphQL schema or API, (2) reviewing existing schema for improvements, (3) deciding on type structures or nullability, (4) implementing pagination or error patterns, (5) ensuring security in schema design.