# api-design-review

Скилл api-design-review для Claude Code проверяет дизайн HTTP API, SDK или CLI. Запускается по просьбе оценить спецификацию, эргономику SDK или риск изменения перед выпуском.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 541 у репозитория
- Автор: dotslashsimran
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/dotslashsimran/simcraft/tree/HEAD/skills/coding/api-design-review/SKILL.md
- Обновлён: 2026-11-09
- Проверка безопасности: автоматическая, 2026-11-17 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/api-design-review

## Что делает

Скилл анализирует структуру API и записывает выводы в `review.md`: оценку по разделам, ранжированные замечания с вариантами исправлений, список рисков несовместимых изменений и удачные решения. Для проверки OpenAPI и публичной поверхности SDK использует скрипты, а изменения между двумя версиями спецификации делит на несовместимые, рискованные и безопасные.

Для работы скриптов нужен Python 3.9 или новее. YAML читается через PyYAML, если он установлен, иначе применяется встроенный разборщик; YAML с якорями или тегами требует PyYAML либо копии в JSON. Скрипт анализа SDK импортирует Python-пакет, поэтому запускайте его только на коде, которому доверяете. Автоматические проверки могут давать ложные срабатывания: их нужно сверять с API.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install dotslashsimran/simcraft skills/coding/api-design-review
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/api-design-review/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add dotslashsimran/simcraft --skill api-design-review -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/dotslashsimran/simcraft --path skills/coding/api-design-review
```

### Windsurf (Devin Desktop)

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

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/dotslashsimran/simcraft/tree/HEAD/skills/coding/api-design-review/SKILL.md

## Когда брать
- найти несогласованные имена и модели ресурсов в API
- проверить две версии OpenAPI на несовместимые изменения
- обнаружить проблемы в ошибках, пагинации и повторных запросах
- оценить публичные классы и функции SDK
- проверить команды и коды выхода CLI

## Примеры запросов агенту
- Проверь дизайн моего API по `openapi.yaml` и сохрани вывод в `review.md`.
- Сравни `old.json` и `new.yaml`: какие изменения несовместимы?
- Разбери публичный интерфейс SDK в `dist/index.d.ts`.

## Похожие
- [public-api-design-review](https://affpapa.org/nevibecode/skills/public-api-design-review.md) — скилл · 10200 установок
- [API Design taste](https://affpapa.org/nevibecode/prompts/api-design-taste.md) — промпт · ★ 178201 у репозитория
- [API Client SDK taste](https://affpapa.org/nevibecode/prompts/api-client-sdk-taste.md) — промпт · ★ 178201 у репозитория
- [api-integration-specialist](https://affpapa.org/nevibecode/agents/api-integration-specialist.md) — субагент · ★ 1013 у репозитория
- [Octri API Docs](https://affpapa.org/nevibecode/mcp/octri-api-docs.md) — MCP-сервер · ★ 4 у репозитория
- [api-design-patterns](https://affpapa.org/nevibecode/skills/api-design-patterns.md) — скилл · 1000 установок

Из того же набора: [dotslashsimran/simcraft](https://affpapa.org/nevibecode/by/dotslashsimran/simcraft.md) — 24 карточки

_Часть страницы не вошла по размеру — она есть в HTML-версии._

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