# api-design-patterns

Скилл с 38 правилами проектирования REST API: ресурсы, ошибки, безопасность, пагинация, версионирование. Пригодится, когда агент пишет или проверяет эндпоинты.

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

## Что делает

Скилл разбит на 7 категорий по приоритету. Критичные — проектирование ресурсов (`rest-`), обработка ошибок (`error-`) и безопасность (`sec-`). Дальше идут пагинация с фильтрацией, версионирование, формат ответа и документация. У каждого правила свой префикс и отдельный файл в `rules/`, например `rules/rest-http-methods.md` или `rules/error-consistent-format.md`.

Внутри есть готовые образцы: формат ответа с ошибкой, структура пагинации с `meta` и `links`, заголовки `X-RateLimit-*`. Агент берёт их как ориентир, когда предлагает вам схему эндпоинта. Полный свод всех правил лежит в `AGENTS.md`.

Скилл не проверяет ваш код сам по себе — он задаёт агенту рамку, в которой тот рассуждает. Если в проекте уже принят другой стиль ответов или версионирование через заголовок, правила про URL-путь и конверт ответа будут спорить с ним. Тогда стоит сказать агенту, какой из подходов считать основным.

## Установка

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

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

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

### Codex

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

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

### Cursor

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

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install AsyrafHussin/agent-skills api-design-patterns
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

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

## Примеры запросов агенту
- спроектируй REST API для заказов по правилам api-design-patterns
- проверь мои эндпоинты на соответствие REST best practices
- сделай единый формат ошибок с request_id для всех ручек

## Похожие
- [rest-api-design](https://affpapa.org/nevibecode/skills/rest-api-design.md) — скилл · 2100 установок
- [public-api-design-review](https://affpapa.org/nevibecode/skills/public-api-design-review.md) — скилл · 7800 установок
- [api-design-reviewer](https://affpapa.org/nevibecode/skills/api-design-reviewer.md) — скилл · 768 установок
- [sap-api-style](https://affpapa.org/nevibecode/skills/sap-api-style.md) — скилл · 785 установок
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/api-reference-documentation.md) — скилл · 494 установки
- [api-design](https://affpapa.org/nevibecode/skills/agent-skills-team-api-design.md) — скилл · 387 установок

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

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

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