# api-design

Скилл api-design задаёт правила проектирования контрактов REST, GraphQL и gRPC при редактировании эндпоинтов и схем OpenAPI. Включается автоматически при работе с файлами в routes/ и спецификациями.

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

## Что делает

Скилл содержит 14 правил в семи категориях: от соглашений REST и схем OpenAPI 3.1 до Strawberry GraphQL и двунаправленных вебсокетов. Он регламентирует структуру URL, пагинацию курсорами, стриминг через SSE с отправкой keepalive каждые 30 секунд и описание ошибок в формате RFC 9457 Problem Details с полями `retryable` и `error_category`.

Для версионирования зафиксирована чёткая политика: поддержка текущей и предыдущей версии, оповещение об устаревании минимум за три месяца и полный вывод из эксплуатации через шесть месяцев. При этом скилл отвечает только за архитектуру сетевых контрактов — писать саму бизнес-логику и рабочий код бэкенда разработчики OrchestKit рекомендуют через отдельный скилл `python-backend`.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install yonatangross/orchestkit src/skills/api-design
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

## Когда брать
- спроектировать контракт REST-эндпоинта с пагинацией курсорами
- оформить ошибки API по стандарту RFC 9457 Problem Details
- составить схему Strawberry GraphQL с защитой от N+1 через DataLoader
- описать политику версионирования и закрытия устаревших маршрутов

## Примеры запросов агенту
- Спроектируй схему OpenAPI 3.1 для управления заказами с пагинацией по курсору
- Опиши ответ с ошибкой валидации для эндпоинта /api/v1/users по стандарту RFC 9457
- Составь контракт эндпоинта со стримингом через SSE и проверкой соединения каждые 30 секунд

## Похожие
- [api-designer](https://affpapa.org/nevibecode/skills/api-designer.md) — скилл · 7100 установок
- [api-architect](https://affpapa.org/nevibecode/skills/api-architect.md) — скилл · 235 установок
- [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-reviewer](https://affpapa.org/nevibecode/skills/borghei-api-design-reviewer.md) — скилл · 167 установок
- [api-design-patterns](https://affpapa.org/nevibecode/skills/bobmatnyc-api-design-patterns.md) — скилл · 585 установок

## Другие версии с тем же именем
- [api-design · affaan-m](https://affpapa.org/nevibecode/skills/api-design.md) — 7500 установок
- [api-design · aaronontheweb](https://affpapa.org/nevibecode/skills/aaronontheweb-api-design.md) — 702 установки
- [api-design · margelo](https://affpapa.org/nevibecode/skills/margelo-api-design.md) — 1400 установок
- [api-design · akillness](https://affpapa.org/nevibecode/skills/agent-skills-team-api-design.md) — 390 установок
- [api-design · travisjneuman](https://affpapa.org/nevibecode/skills/travisjneuman-api-design.md) — 170 установок

Из того же набора: [yonatangross/orchestkit](https://affpapa.org/nevibecode/by/yonatangross/orchestkit.md) — 86 карточек

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

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