
Api Design
Covers REST conventions, GraphQL schema design, versioning strategies, and RFC 9457 Problem Details error handling across 18 rules in 7 categories. You'll reach for this when deciding between URL path versioning and header versioning, implementing standardized error responses with `application/problem+json`, or setting up OpenAPI specs. The agent-facing errors section is especially solid, adding `retryable` and `error_category` fields that actually help AI clients handle failures intelligently. Also includes patterns for gRPC services, SSE/WebSocket streaming, and messaging platform integrations like WhatsApp and Telegram. The deprecation and sunset policy guidance (3 month notice, 6 month window) is more opinionated than most API skills, which is helpful when you need a concrete answer rather than endless options.
- skills.sh installs
- 211
- GitHub stars
- 301
- last updated
- Aug 21, 2026
Install
$ npx -y skills add yonatangross/orchestkit --skill api-design --agent claude-codeInstalls into .claude/skills of the current project.
Files
API Design
Comprehensive API design patterns covering REST/GraphQL framework design, versioning strategies, and RFC 9457 error handling. Each category has individual rule files in rules/ loaded on-demand.
Quick Reference
| Category | Rules | Impact | When to Use |
|---|---|---|---|
| API Framework | 3 | HIGH | REST conventions, resource modeling, OpenAPI specifications |
| Versioning | 2 | HIGH | URL path versioning, header versioning; deprecation windows are house policy in references/ork-delta.md |
| Error Handling | 1 | HIGH | Agent-facing RFC 9457 extensions; base spec and FastAPI wiring are upstream |
| GraphQL | 2 | HIGH | Strawberry code-first, DataLoader, permissions, subscriptions |
| gRPC | 2 | HIGH | Protobuf services, streaming, interceptors, retry |
| Streaming | 2 | HIGH | SSE endpoints, WebSocket bidirectional, async generators |
| Integrations | 2 | HIGH | Messaging platforms (WhatsApp, Telegram), Payload CMS patterns |
Sponsors
Details
- Repository
- github.com/yonatangross/orchestkit
- Categories
- Backend & APIs, Debugging, Design & UI/UX
- First seen
- Jun 3, 2026
More from yonatangross/orchestkit
All 61- Assess211
- Analytics210
- Commit210
- Skill Evolution210
- Verify210
- Create Pr209
- Audit Full206
- Implement206
- Configure196
- Demo Producer195
- Async Jobs194
- Golden Dataset193
- Product Frameworks193
- Browser Tools191
- Mcp Patterns190
- Feedback180
- Scope Appropriate Architecture179
- Testing Patterns179
- Help166
- Checkpoint Resume156
- Dashboard Patterns124
- Devops Deployment1.6K
- Responsive Patterns1.6K
- Architecture Decision Record1.5K