# spring-boot-openapi-documentation

Скилл помогает агенту настроить SpringDoc OpenAPI 3.0 и Swagger UI в проекте на Spring Boot 3.x и разметить эндпоинты аннотациями.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 4000 установок · ★ 363
- Автор: giuseppe-trisciuoglio
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/giuseppe-trisciuoglio/developer-kit/tree/HEAD/plugins/developer-kit-java/skills/spring-boot-openapi-documentation/SKILL.md
- Обновлён: 2026-09-10
- HTML: https://affpapa.org/nevibecode/skills/spring-boot-openapi-documentation

## Что делает

Скилл задаёт агенту порядок работы с документацией REST API: подключить стартер SpringDoc, прописать параметры в `application.yml`, разметить контроллеры и DTO. Внутри — справочники по зависимостям Maven и Gradle, конфигурации, аннотациям, безопасности, пагинации, обработке исключений и сборке. Агент читает нужный файл и применяет шаблон к вашему коду.

Документирование строится на аннотациях `@Tag`, `@Operation`, `@ApiResponse`, `@Parameter`, `@Schema` и `@SecurityRequirement`. Схемы безопасности (JWT, OAuth2, Basic Auth, API-ключ) описываются в бине `OpenAPI`, а на контроллерах подключаются через `@SecurityRequirement`. Для Spring Data `Pageable` скилл советует `@ParameterObject` — иначе параметры страницы расползутся по отдельным полям и Swagger UI покажет их нечитаемо.

Готовые точки доступа: JSON спецификации на `/v3/api-docs`, интерфейс на `/swagger-ui/index.html`. В разделе ограничений прямо сказано: не выносите чувствительные данные в примеры и описания схем. Скилл рассчитан на WebMvc и WebFlux, есть поддержка Kotlin.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill spring-boot-openapi-documentation -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill spring-boot-openapi-documentation -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill spring-boot-openapi-documentation -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install giuseppe-trisciuoglio/developer-kit spring-boot-openapi-documentation
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill spring-boot-openapi-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/giuseppe-trisciuoglio/developer-kit --path plugins/developer-kit-java/skills/spring-boot-openapi-documentation
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add giuseppe-trisciuoglio/developer-kit --skill spring-boot-openapi-documentation -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/giuseppe-trisciuoglio/developer-kit/tree/HEAD/plugins/developer-kit-java/skills/spring-boot-openapi-documentation/SKILL.md

## Когда брать
- подключить SpringDoc к проекту на Spring Boot 3.x
- разметить контроллеры аннотациями OpenAPI
- описать DTO и ограничения валидации в схемах
- настроить схемы безопасности JWT или OAuth2
- задокументировать постраничные эндпоинты с Pageable

## Примеры запросов агенту
- настрой SpringDoc OpenAPI в этом Spring Boot проекте
- добавь аннотации @Operation и @ApiResponse к контроллерам BookController
- опиши схему bearer-jwt в бине OpenAPI и подключи её к защищённым эндпоинтам

## Похожие
- [302-frameworks-spring-boot-rest](https://affpapa.org/nevibecode/skills/302-frameworks-spring-boot-rest.md) — скилл · 392 установки
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/api-reference-documentation.md) — скилл · 494 установки
- [spring-boot-engineer](https://affpapa.org/nevibecode/skills/spring-boot-engineer.md) — скилл · 8400 установок
- [spring-boot](https://affpapa.org/nevibecode/skills/spring-boot.md) — скилл · 832 установки
- [spring-boot-development](https://affpapa.org/nevibecode/skills/spring-boot-development.md) — скилл · 534 установки
- [spring-boot-patterns](https://affpapa.org/nevibecode/skills/spring-boot-patterns.md) — скилл · 322 установки

Из того же набора: [giuseppe-trisciuoglio/developer-kit](https://affpapa.org/nevibecode/by/giuseppe-trisciuoglio/developer-kit.md) — 93 карточки

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

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