# api-design-reviewer

Скилл api-design-reviewer для Claude Code проверяет спецификации OpenAPI, находит несовместимые изменения между версиями и оценивает зрелость контракта REST API.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 167 установок · ★ 1183 у репозитория
- Автор: borghei
- Лицензия: LicenseRef-MIT-Commons-Clause · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/borghei/Claude-Skills/tree/HEAD/engineering/api-design-reviewer/SKILL.md
- Обновлён: 2026-11-08
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/borghei-api-design-reviewer

## Что делает

Набор из трёх Python-скриптов работает в Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode. Утилита `api_linter.py` проверяет URL, методы HTTP, структуру ошибок и правила именования (kebab-case для путей и camelCase для полей).

Скрипт `breaking_change_detector.py` сравнивает два файла спецификаций, отслеживая удалённые эндпоинты, смену типов полей и добавление обязательных параметров. Для интеграции в пайплайны предусмотрен флаг `--exit-on-breaking`, возвращающий код 1 при несовместимости контрактов.

Для запуска скриптов в окружении нужен Python, а спецификации должны быть валидным JSON в формате OpenAPI или Swagger, иначе утилиты завершаются с кодом 2. Третий инструмент, `api_scorecard.py`, выставляет оценку от A до F по пяти категориям от безопасности до производительности.

## Установка

### Claude Code (родная платформа)

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

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/api-design-reviewer/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/api-design-reviewer/

### Codex

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

2. **Вручную: положить файлы**
- Файл: `.agents/skills/api-design-reviewer/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

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

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/api-design-reviewer/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

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

2. **Вручную: положить файлы**
- Файл: `.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. **Командой платформы**
```bash
gemini skills install https://github.com/borghei/Claude-Skills --path engineering/api-design-reviewer
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/api-design-reviewer/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

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

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/borghei/Claude-Skills/tree/HEAD/engineering/api-design-reviewer/SKILL.md

## Когда брать
- найти несовместимые изменения между двумя версиями OpenAPI
- проверить URL и методы на соответствие соглашениям REST
- выявить отсутствие схем ошибок и примеров в документации
- заблокировать сборку в CI при нарушении контракта API

## Примеры запросов агенту
- Проверь файл openapi.json через api_linter.py
- Сравни спецификации v1.json и v2.json на критические изменения
- Оцени качество API в swagger.json скриптом api_scorecard.py

## Похожие
- [public-api-design-review](https://affpapa.org/nevibecode/skills/public-api-design-review.md) — скилл · 10200 установок
- [rest-api-design](https://affpapa.org/nevibecode/skills/rest-api-design.md) — скилл · 2100 установок
- [api-design](https://affpapa.org/nevibecode/skills/agent-skills-team-api-design.md) — скилл · 390 установок
- [design-rest-api](https://affpapa.org/nevibecode/commands/design-rest-api.md) — команда · 559 установок
- [openapi-expert](https://affpapa.org/nevibecode/skills/openapi-expert.md) — скилл · 282 установки
- [openapi-spec-writer](https://affpapa.org/nevibecode/skills/openapi-spec-writer.md) — скилл · 175 установок

## Другие версии с тем же именем
- [api-design-reviewer · alirezarezvani](https://affpapa.org/nevibecode/skills/api-design-reviewer.md) — 768 установок

Из того же набора: [borghei/claude-skills](https://affpapa.org/nevibecode/by/borghei/claude-skills.md) — 120 карточек

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
