1
# API Design Review
2
3
An API is the hardest thing in a codebase to change, because someone else's code
4
depends on the exact shape of it. This review catches the decisions that become
5
permanent: what the resources are called, how errors are reported, how a client pages
6
through results, and which fields you will regret making required.
7
8
## When to use
9
10
- Before the first client integrates against a new interface.
11
- When adding an endpoint to an existing API, to keep it consistent.
12
- Before making anything public, where a breaking change costs the most.
13
14
## Install
15
16
```bash
17
npx openagents-cli add openagents/api-design-review
18
```
19
20
| Runtime | Installed to |
21
|---|---|
22
| `claude-code` | `.claude/skills/api-design-review/` |
23
| `cursor` | `.cursor/rules/api-design-review/` |
24
| `codex` | `.codex/skills/api-design-review/` |
25
| `openai-agents` | `agents/api-design-review/` |
26
| `generic` | `.openagents/api-design-review/` |
27
28
## What is in the package
29
30
- `SKILL.md` - what to review, in order of how expensive it is to get wrong.
31
- `checklist.md` - the pass, as concrete questions.
32
33
## License
34
35
MIT
36