# api-design

Скилл api-design для Claude Code содержит правила и шаблоны проектирования REST, gRPC и tRPC API, помогает составить спецификацию OpenAPI и упорядочить роуты.

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

## Что делает

Скилл содержит готовые шаблоны архитектурных решений для веб-сервисов. Внутри собраны правила именования эндпоинтов существительными во множественном числе, матрица методов HTTP и сценарии применения статус-кодов для успешных ответов и ошибок. Также описаны схемы курсорной пагинации, фильтрация параметров и версионирование через путь URL.

Помимо классического REST скилл задаёт формат спецификаций OpenAPI 3.0 с блоками авторизации по токенам JWT или ключам API. Для сетевого взаимодействия микросервисов включены протоколы gRPC с protobuf-контрактами и примеры сквозных роутеров на tRPC с валидацией через Zod.

Если архитектура опирается на кастомные глаголы в путях, скилл сразу перестроит их под ресурсную модель.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add travisjneuman/.claude --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 travisjneuman/.claude --skill api-design -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add travisjneuman/.claude --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 travisjneuman/.claude skills/api-design
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

## Когда брать
- Спроектировать консистентную структуру REST-эндпоинтов без глаголов в URL
- Описать спецификацию OpenAPI 3.0 с валидацией схем и JWT-авторизацией
- Настроить курсорную пагинацию и формат ответов для коллекций
- Оформить proto-файлы для межсервисного взаимодействия по gRPC

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

## Похожие
- [api-error-design](https://affpapa.org/nevibecode/skills/api-error-design.md) — скилл · 10200 установок
- [api-architect](https://affpapa.org/nevibecode/skills/api-architect.md) — скилл · 235 установок
- [api-design-patterns](https://affpapa.org/nevibecode/skills/bobmatnyc-api-design-patterns.md) — скилл · 585 установок
- [api-contract-design](https://affpapa.org/nevibecode/skills/api-contract-design.md) — скилл · ★ 587 у репозитория
- [public-api-design-review](https://affpapa.org/nevibecode/skills/public-api-design-review.md) — скилл · 10200 установок
- [api-expert](https://affpapa.org/nevibecode/skills/api-expert.md) — скилл · 258 установок

## Другие версии с тем же именем
- [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 · yonatangross](https://affpapa.org/nevibecode/skills/orchestkit-api-design.md) — 211 установок
- [api-design · akillness](https://affpapa.org/nevibecode/skills/agent-skills-team-api-design.md) — 390 установок

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

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

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