Design REST APIs that are consistent, versioned, and developer-friendly: resource naming, pagination, filtering, error responses, rate limiting, and HATEOAS.
When to use this skill
- Designing a new API endpoint
- Choosing a pagination strategy
- Writing API error responses
Core concepts
This skill provides guidance on api design best practices, patterns, and common pitfalls. It is designed to be loaded on demand when a relevant task is detected.
Installation
curl -LO https://opencode-skills.example/downloads/architecture/api-design.zip
unzip api-design.zip -d ~/.config/opencode/skills/Restart OpenCode — the skill loads automatically.
When it triggers
- designing a new API endpoint
- choosing a pagination strategy
- writing API error responses