# API Design

> Provides API design guidelines for REST endpoints, GraphQL schemas, versioning strategies, error handling conventions, logging, observability, and microservice architecture patterns. Use when designing APIs, reviewing API architecture, implementing new endpoints, setting up monitoring, or planning service boundaries.

- Skill: `kcenon/api-design` (Agent Skill, multi-file: 5 files)
- Install (CLI): `npx skillmds@latest add kcenon/api-design`
- Raw SKILL.md: https://api.skillmd.com/api/skills/kcenon/api-design/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: kcenon (https://skillmd.com/u/kcenon)
- Updated: 2026-09-10
- Page: https://skillmd.com/skills/kcenon/api-design

---


# 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