# api-design-expert

Скилл api-design-expert для проектирования HTTP API: ресурсы REST, выбор между GraphQL и gRPC, схемы версионирования и единый формат ошибок. Полезен до того, как написан первый эндпоинт.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 180 установок · ★ 45 у репозитория
- Автор: personamanagmentlayer
- Лицензия: Apache-2.0 · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/personamanagmentlayer/pcl/tree/HEAD/stdlib/api/api-design-expert/SKILL.md
- Обновлён: 2026-10-12
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/api-design-expert

## Что делает

Скилл подключается сам, когда в задаче всплывают REST, GraphQL, версии API или безопасность API. Агенту он даёт рабочую рамку: ресурсно-ориентированный REST, другие стили вроде gRPC, WebSocket и server-sent events, а поверх — версионирование, аутентификация, лимиты запросов и совместимость со старыми клиентами.

Примеры внутри на Python. Приложение на FastAPI с моделями Pydantic показывает списочные методы с пагинацией и сортировкой, вложенные ресурсы и три способа версионирования: в пути (`/api/v1`), через заголовок `API-Version` и через content negotiation. Отдельно разобраны обработчики исключений, которые сводят ошибки валидации и бизнес-ошибки к одному телу ответа.

Вот тут и ограничение: стек примеров — FastAPI и Pydantic, так что для Express, Spring или Go шаблоны придётся переносить руками. Скилл задаёт форму, а не генерирует код под любой фреймворк. Разрешённых инструментов три: `Read`, `Write` и `Edit` — файлы читает и правит, а тесты не запускает.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install personamanagmentlayer/pcl stdlib/api/api-design-expert
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/personamanagmentlayer/pcl --path stdlib/api/api-design-expert
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add personamanagmentlayer/pcl --skill api-design-expert -a opencode
```

### Claude.ai

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

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

## Когда брать
- Разложить ресурсы и эндпоинты REST-сервиса до написания обработчиков
- Выбрать схему версионирования: путь, заголовок или content negotiation
- Свести ошибки валидации и бизнес-ошибки к одному формату ответа
- Взвесить REST против GraphQL или gRPC для нового сервиса
- Добавить пагинацию и сортировку в списочные методы

## Примеры запросов агенту
- Спроектируй REST API для заказов: ресурсы, методы, коды ответов, версия в пути `/api/v1`
- Сравни REST и GraphQL для нашего сервиса и объясни, что выбрать
- Перепиши ответы с ошибками так, чтобы у всех были одинаковые поля

## Похожие
- [api-design](https://affpapa.org/nevibecode/skills/agent-skills-team-api-design.md) — скилл · 390 установок
- [api-rate-limit-policy](https://affpapa.org/nevibecode/skills/api-rate-limit-policy.md) — скилл · 10400 установок
- [public-api-design-review](https://affpapa.org/nevibecode/skills/public-api-design-review.md) — скилл · 10200 установок
- [api-and-interface-design](https://affpapa.org/nevibecode/skills/api-and-interface-design.md) — скилл · 79800 установок
- [api-design-principles](https://affpapa.org/nevibecode/skills/api-design-principles.md) — скилл · 30348 установок
- [api-design-patterns](https://affpapa.org/nevibecode/skills/bobmatnyc-api-design-patterns.md) — скилл · 585 установок

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

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

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