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.
Scanned 5/31/2026
Install via CLI
openskills install diegosouzapw/awesome-omni-skill---
name: api-design
description: 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.
---
# 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
No comments yet. Be the first to comment!
Ultra-compressed code review comments. Cuts noise from PR feedback while preserving the actionable signal. Each comment is one line: location, problem, fix. Use when user says "review this PR", "code review", "review the diff", "/review", or invokes /caveman-review. Auto-triggers when reviewing pull requests.