api-design-patterns

Design and enforce REST and GraphQL API design patterns.

Updated Oct 26, 2025
One-click install
npx skills add https://github.com/Hieubkav/wincellarCloneBackend --skill api-design-patterns-hieubkav
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-patterns
Source: https://github.com/Hieubkav/wincellarCloneBackend/tree/main/.claude/skills/api/api-design-patterns
Command: npx skills add https://github.com/Hieubkav/wincellarCloneBackend --skill api-design-patterns-hieubkav

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill consolidates best practices for API design, versioning, authentication, error handling, and documentation to build intuitive, scalable backends.

Core Features & Use Cases

  • REST and GraphQL design principles
  • OpenAPI/Swagger documentation guidance
  • Versioning, authentication, error handling, and rate limiting
  • Reference patterns and real-world examples

Quick Start

Design a new REST API endpoint following standardized resource-oriented conventions.

Frequently Asked Questions about api-design-patterns

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design a REST API following best practices for scalability and security?

REST API design relies on resource-oriented URIs, proper HTTP method semantics, appropriate status codes, and schema validation. This Skill consolidates patterns for authentication, error handling, versioning, and rate limiting to create maintainable, secure endpoints that scale with your backend requirements.

What's the difference between REST and GraphQL API design approaches?

REST uses resource-oriented URIs and HTTP verbs for operations; GraphQL uses schema-first queries for precise data fetching. This Skill covers design principles, authentication, versioning, and error handling for both paradigms so you can choose the right approach for your use case.

How do I document my API with OpenAPI and enforce design standards?

OpenAPI specifications formalize REST API contracts through structured documentation. This Skill provides guidance on generating OpenAPI/Swagger docs, establishing resource and status-code conventions, and implementing deprecation policies to maintain API consistency across versions.

How should I handle API versioning, authentication, and rate limiting?

API versioning strategies, authentication mechanisms, and rate-limiting rules must align with your resource design. This Skill covers patterns for all three—including deprecation workflows—to ensure secure, predictable scaling as your API evolves.

Can I use these patterns for both new APIs and refactoring existing endpoints?

Yes. This Skill applies to designing new REST or GraphQL APIs, refactoring existing endpoints, establishing organizational standards, and reviewing specifications. Patterns cover resource conventions, HTTP semantics, schema validation, and error handling across both scenarios.

What should I consider when planning pagination and monitoring for my API?

Pagination strategies and monitoring enable APIs to handle scale. This Skill addresses pagination design patterns, rate-limiting mechanisms, error-handling conventions, and monitoring approaches to ensure your API remains responsive and observable under load.