# API Design

> 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.

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

---


# 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