# api-contract-design

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

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 587 у репозитория
- Автор: Rudolf S.
- Лицензия: MIT · policy=mirror · лицензия открытая, файл — в исходнике
- Исходник: https://github.com/rsmdt/the-startup/tree/HEAD/plugins/team/skills/development/api-contract-design/SKILL.md
- Обновлён: 2026-10-26
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/api-contract-design

## Что делает

Скилл разбирает требования и потребителей API, предлагает стиль интерфейса и помогает описать контракт до реализации. Он охватывает REST, GraphQL и гибридный вариант, а также схемы запросов и ответов, ошибки, пагинацию, версионирование и аутентификацию. Решения сопровождаются обоснованием.

В процессе учитываются единые правила именования и ответов, обратная совместимость и изменения API. Для спецификаций OpenAPI предусмотрены отдельные справочные материалы; для REST и GraphQL тоже есть файлы с шаблонами проектирования. Скилл требует определить хотя бы основного потребителя API и не допускает GET-запросов с побочными эффектами.

Проверка контракта затрагивает формат дат ISO 8601, обработку ошибок и совместимость с существующими потребителями. Для небезопасных операций с побочными эффектами скилл требует ключи идемпотентности, а API предлагает использовать только HTTPS. Это важно учесть до того, как контракт перейдёт в реализацию.

## Установка

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

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add rsmdt/the-startup
```
В чате агента (не в терминале):
```text
/plugin install team@the-startup
```
Команда ставит плагин team целиком, со всеми его скиллами

2. **Через Skills CLI (Vercel)**
```bash
npx skills add rsmdt/the-startup --skill api-contract-design -a claude-code
```

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install rsmdt/the-startup plugins/team/skills/development/api-contract-design
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/rsmdt/the-startup --path plugins/team/skills/development/api-contract-design
```

### Windsurf (Devin Desktop)

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

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/rsmdt/the-startup/tree/HEAD/plugins/team/skills/development/api-contract-design/SKILL.md

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

## Примеры запросов агенту
- Спроектируй REST API для управления заказами и сначала опиши контракт.
- Проверь контракт GraphQL для мобильного приложения: найди проблемы со схемой и обработкой ошибок.
- Подготовь спецификацию OpenAPI для этого набора эндпоинтов и проверь её на совместимость.

## Похожие
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/api-reference-documentation.md) — скилл · 501 установка
- [api-documentation-generator](https://affpapa.org/nevibecode/skills/api-documentation-generator.md) — скилл · 235 установок
- [api-architect](https://affpapa.org/nevibecode/skills/api-architect.md) — скилл · 235 установок
- [doc-api](https://affpapa.org/nevibecode/commands/doc-api.md) — команда · 733 установки
- [api-integration-specialist](https://affpapa.org/nevibecode/agents/api-integration-specialist.md) — субагент · ★ 1013 у репозитория
- [api-design](https://affpapa.org/nevibecode/skills/agent-skills-team-api-design.md) — скилл · 390 установок

Из того же набора: [rsmdt/the-startup](https://affpapa.org/nevibecode/by/rsmdt/the-startup.md) — 50 карточек

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