api-design

kcenon's avatarfrom kcenon

Provides API design guidelines for REST, GraphQL, versioning, logging, observability, and architecture patterns. Use when designing APIs, reviewing architecture, implementing microservices, or setting up monitoring.

⭐1stars🔀0forks📁View on GitHub🕐Updated Dec 21, 2025⬇️1downloads
[Architecture Design]

When & Why to Use This Skill

This Claude skill serves as a comprehensive technical consultant for modern software architecture, providing expert-level guidelines for REST and GraphQL API design, microservices orchestration, and system observability. It helps developers and architects implement industry best practices for versioning, structured logging, and performance monitoring to ensure scalable and maintainable software systems.

Use Cases

  • Designing scalable RESTful or GraphQL APIs with robust versioning, authentication, and rate-limiting strategies.
  • Architecting microservices ecosystems using SOLID principles and proven design patterns for high availability.
  • Implementing structured logging and observability frameworks (metrics, traces, health checks) to enhance system reliability.
  • Conducting technical architecture reviews to ensure API endpoints and system components meet security and performance standards.
nameapi-design
descriptionProvides API design guidelines for REST, GraphQL, versioning, logging, observability, and architecture patterns. Use when designing APIs, reviewing architecture, implementing microservices, or setting up monitoring.

API Design Skill

When to Use

  • Designing REST or GraphQL APIs
  • Architecture and microservices design
  • Setting up logging and observability
  • Implementing rate limiting or authentication
  • Code review for API endpoints

Reference Documents (Import Syntax)

API Design

@reference/api-design.md

Architecture

@reference/architecture.md

Observability

@reference/logging.md @reference/observability.md

Core Principles

  1. RESTful conventions: Use proper HTTP methods and status codes
  2. SOLID principles: Apply design patterns appropriately
  3. Structured logging: Include context and correlation IDs
  4. Observability: Implement metrics, traces, and health checks