# api-design-reviewer

api-design-reviewer — a skill for Claude Code inspects OpenAPI specs, catches breaking schema changes between versions, and grades REST API architecture maturity.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 167 installs · ★ 1183 repo stars
- Author: borghei
- License: LicenseRef-MIT-Commons-Clause · policy=link-only · description only; the file stays with the author
- Source: https://github.com/borghei/Claude-Skills/tree/HEAD/engineering/api-design-reviewer/SKILL.md
- Updated: 2026-11-08
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/borghei-api-design-reviewer

## What it does

Works across Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, and OpenCode through three bundled Python CLIs. The `api_linter.py` script validates paths, HTTP verbs, error payloads, and naming rules, catching issues like verbs in URL paths or wrong field casing.

The `breaking_change_detector.py` utility compares two API spec versions to spot removed endpoints, altered data types, or newly required fields. With `--exit-on-breaking`, it exits with code 1, making it suitable for CI pull request gates.

Your environment requires Python and valid OpenAPI or Swagger JSON files; malformed JSON or unreadable paths exit immediately with code 2. The third tool, `api_scorecard.py`, measures design maturity across five weighted areas to deliver a letter grade from A to F.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill api-design-reviewer -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/api-design-reviewer/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/api-design-reviewer/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill api-design-reviewer -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/api-design-reviewer/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill api-design-reviewer -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/api-design-reviewer/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install borghei/Claude-Skills engineering/api-design-reviewer/SKILL.md
```

2. **Manually: put the files in place**
- File: `.github/skills/api-design-reviewer/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill api-design-reviewer -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/borghei/Claude-Skills --path engineering/api-design-reviewer
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/api-design-reviewer/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add borghei/Claude-Skills --skill api-design-reviewer -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/borghei/Claude-Skills/tree/HEAD/engineering/api-design-reviewer/SKILL.md

## When to use it
- catch breaking API changes between two schema releases
- audit REST paths and HTTP methods against standard conventions
- score API completeness across security, docs, and usability
- fail continuous integration checks on contract violations

## Example prompts
- Run api_linter.py on openapi.json to check REST conventions
- Diff v1.json and v2.json with breaking_change_detector.py
- Calculate an architecture maturity score for swagger.json

## Similar
- [public-api-design-review](https://affpapa.org/en/nevibecode/skills/public-api-design-review.md) — skill · 10200 installs
- [rest-api-design](https://affpapa.org/en/nevibecode/skills/rest-api-design.md) — skill · 2100 installs
- [api-design](https://affpapa.org/en/nevibecode/skills/agent-skills-team-api-design.md) — skill · 390 installs
- [design-rest-api](https://affpapa.org/en/nevibecode/commands/design-rest-api.md) — command · 559 installs
- [openapi-expert](https://affpapa.org/en/nevibecode/skills/openapi-expert.md) — skill · 282 installs
- [openapi-spec-writer](https://affpapa.org/en/nevibecode/skills/openapi-spec-writer.md) — skill · 175 installs

## Other versions with the same name
- [api-design-reviewer · alirezarezvani](https://affpapa.org/en/nevibecode/skills/api-design-reviewer.md) — 768 installs

From the same set: [borghei/claude-skills](https://affpapa.org/en/nevibecode/by/borghei/claude-skills.md) — 120 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
