# openapi-spec-writer

Скилл openapi-spec-writer проектирует спецификации OpenAPI 3.0 и 3.1 для REST API. Помогает составить схемы данных и настроить документацию ещё до написания серверного кода.

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

## Что делает

Скилл генерирует спецификации REST API в форматах OpenAPI 3.0 и 3.1. Он описывает маршруты, коды ответов, параметры запросов и структуры моделей на базе JSON Schema. Для сложных сущностей используются дискриминаторы полиморфизма, а также композиции `oneOf`, `anyOf` и `allOf`. В спецификацию сразу добавляются реалистичные примеры полезной нагрузки, описания ошибок и отметки устаревших методов.

Помимо описания эндпоинтов, скилл настраивает экосистему вокруг контракта. Он готовит конфигурации для Swagger UI и Redoc, создаёт мок-серверы и формирует правила линтинга через Spectral. Без строгой типизации полей Spectral сразу выдаст ошибку валидации схемы.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add curiositech/some_claude_skills --skill openapi-spec-writer -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add curiositech/some_claude_skills --skill openapi-spec-writer -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add curiositech/some_claude_skills --skill openapi-spec-writer -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install curiositech/some_claude_skills .claude/skills/openapi-spec-writer
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add curiositech/some_claude_skills --skill openapi-spec-writer -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/curiositech/some_claude_skills --path .claude/skills/openapi-spec-writer
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add curiositech/some_claude_skills --skill openapi-spec-writer -a opencode
```

### Claude.ai

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

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

## Когда брать
- описать контракты REST API в формате OpenAPI 3.0 или 3.1
- добавить схемы валидации параметров и тел запросов через JSON Schema
- перенести старую спецификацию Swagger 2.0 на версию 3.x
- настроить правила Spectral и документацию для Swagger UI или Redoc

## Примеры запросов агенту
- Спроектируй спецификацию OpenAPI 3.1 для сервиса задач с Bearer-авторизацией
- Опиши схему ответа с пагинацией и фильтрами по статусу для эндпоинта `GET /tasks`
- Сконвертируй старый файл Swagger 2.0 в формат OpenAPI 3.0 с примерами ошибок

## Похожие
- [openapi-expert](https://affpapa.org/nevibecode/skills/openapi-expert.md) — скилл · 282 установки
- [openapi](https://affpapa.org/nevibecode/skills/oakoss-openapi.md) — скилл · 197 установок
- [spring-boot-openapi-documentation](https://affpapa.org/nevibecode/skills/spring-boot-openapi-documentation.md) — скилл · 4200 установок
- [api-documentation-writer](https://affpapa.org/nevibecode/skills/api-documentation-writer.md) — скилл · 389 установок
- [api-design-reviewer](https://affpapa.org/nevibecode/skills/borghei-api-design-reviewer.md) — скилл · 167 установок
- [go-openapi](https://affpapa.org/nevibecode/skills/go-openapi.md) — скилл · ★ 90 у репозитория

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

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

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