# api-designer

Помогает спроектировать новый API или разобрать существующий: ресурсы, методы, коды ответов, пагинация, версии. Пригодится, когда контракт ещё не зафиксирован.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 698 установок · ★ 84
- Автор: zhaono1
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/zhaono1/agent-playbook/tree/HEAD/skills/api-designer/SKILL.md
- Обновлён: 2026-09-15
- HTML: https://affpapa.org/nevibecode/skills/zhaono1-api-designer

## Что делает

Скилл включается, когда вы просите агента спроектировать API, проверить чужой дизайн, доработать имеющийся или собрать спецификацию. Внутри — набор правил: ресурсные URL вместо глаголов, таблица HTTP-методов с признаками safe и idempotent, разбор кодов от 200 до 500, пагинация через `page` и `page_size`, фильтры и сортировка вида `?status=active&sort=-created_at,name`.

Для GraphQL свои требования: ненулевые поля по умолчанию, курсорная пагинация через Connection и PageInfo, payload-типы у мутаций, описания у всех типов. Версионирование скилл советует начинать с v1 и держать обратную совместимость, а схемы авторизации разбирает по трём вариантам — JWT, API-ключ, OAuth 2.0.

Два скрипта на Python делают рутину: `python3 scripts/generate_api.py --name <resource-name> --output api-design.md` собирает каркас, `python3 scripts/validate_api.py --input api-design.md` проверяет готовый файл. Оба лежат в репозитории, так что без локального Python они не запустятся. В `allowed-tools` прописан доступ к `WebFetch` и `WebSearch` — агент может подтянуть внешние материалы по REST и GraphQL.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-designer -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-designer -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-designer -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install zhaono1/agent-playbook api-designer
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-designer -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/zhaono1/agent-playbook --path skills/api-designer
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-designer -a opencode
```

### Claude.ai

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

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

## Когда брать
- спроектировать ресурсные URL вместо глагольных эндпоинтов
- подобрать корректный код ответа под каждую ситуацию
- добавить пагинацию и сортировку в листинг
- описать схему GraphQL с курсорами и payload-типами
- проверить готовую спецификацию скриптом

## Примеры запросов агенту
- Спроектируй REST API для заказов: список, создание, обновление, удаление
- Проверь мою схему GraphQL и скажи, где нарушены best practices
- Сгенерируй каркас API для ресурса invoices в api-design.md

## Похожие
- [api-integration-surface-strategy](https://affpapa.org/nevibecode/skills/api-integration-surface-strategy.md) — скилл · 8000 установок
- [api-testing-patterns](https://affpapa.org/nevibecode/skills/api-testing-patterns.md) — скилл · 605 установок
- [api-and-interface-design](https://affpapa.org/nevibecode/skills/api-and-interface-design.md) — скилл · 62600 установок
- [api-design-principles](https://affpapa.org/nevibecode/skills/api-design-principles.md) — скилл · 30348 установок
- [api-rate-limit-policy](https://affpapa.org/nevibecode/skills/api-rate-limit-policy.md) — скилл · 8000 установок
- [api-testing](https://affpapa.org/nevibecode/skills/api-testing.md) — скилл · 1300 установок

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

Из того же набора: [zhaono1/agent-playbook](https://affpapa.org/nevibecode/by/zhaono1/agent-playbook.md) — 18 карточек

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

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