API Design Patterns

A comprehensive skill for designing, documenting, and implementing APIs that developers love to use. Covers REST, GraphQL, and hybrid approaches with emphasis on consistency, discoverability, and maintainability.

When to Use

• Designing new REST or GraphQL APIs from scratch
• Reviewing existing API contracts for consistency and best practices
• Evaluating API technologies and frameworks
• Implementing API versioning strategies
• Designing authentication and authorization flows
• Creating OpenAPI/Swagger specifications
• Building developer-friendly API documentation

Core Principles

1. Contract-First Design

Define the API contract before implementation. This enables parallel development, clearer communication, and better documentation.