4

    Api Designer

    by Roy Yuen

    Professional API design and review skill for REST, GraphQL, and event-driven architectures.

    Updated Jun 2026
    452 views
    Security scanned

    $5

    · or 25 credits

    30-day refund guarantee

    Secure checkout via Stripe

    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

    Sample input

    Design a REST endpoint for creating a new order. Include the request/response shapes, use UUIDs for IDs, and define a specific error case for invalid inventory items.

    Sample output

    API Style: REST Resource: /orders POST /orders: Creates a pending order. Request: { userId: UUID, items: Array } 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.

    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

    Reviews

    No reviews yet - be the first to share your experience.

    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

    Tags

    api-design
    architecture
    backend-development
    developer-tools
    graphql
    rest-api

    Claude Code, Codex, and OpenCode.

    Creator

    Roy Yuen

    Frequently Asked Questions

    Learn More About AI Agent Skills

    More Premium Skills

    inline-comment

    inline-comment

    Best way to steer your agents, effortlessly.

    $9.994 installs

    designing-hybrid-context-layers

    Architects the right retrieval strategy for every query — teaching your agent when to use RAG, a knowledge graph, or a temporal index instead of defaulting to vector search for everything.

    $1016 installs

    ai-automation-qa-pack

    Professional QA & UAT documentation generator for AI automation agencies and complex agent deployments.

    $510 installs

    Bounty Security Pattern Master Library — 399 Vulnerability Patterns

    A premium library of 399 vulnerability patterns and DeFi attack vectors for AI-driven bug hunting and security audits.

    $759 installs

    $5