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.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
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
- RESTful conventions: Use proper HTTP methods and status codes
- SOLID principles: Apply design patterns appropriately
- Structured logging: Include context and correlation IDs
- Observability: Implement metrics, traces, and health checks
Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!