К основному содержанию
субагент CX Codex официальный · GitHub

OpenAPI to Application Generator (Spring Boot) — субагент

Субагент OpenAPI to Application Generator (Spring Boot) для GitHub Copilot создаёт Spring Boot-приложение по спецификации OpenAPI, сохраняя схемы и коды ошибок контракта.

MIT ★ 41 430 обновлён 2026-10-23

Установить в GitHub Copilot · Вручную: положить файлы Все способы и платформы ↓
.github/agents/openapi-to-application-java-spring-boot.agent.md
Открыть на GitHub

Что делает OpenAPI to Application Generator (Spring Boot)

Субагент проверяет спецификацию OpenAPI, затем настраивает генерацию интерфейсов API и DTO через openapi-generator. Остальную логику он распределяет по контроллерам и сервисам, а сущности хранения отделяет от DTO. Если спецификация неоднозначна, субагент должен спросить, прежде чем менять контракт.

Он добавляет обработку ошибок и проверки для операций, собирает проект и запускает приложение для проверки endpoint. Для новых проектов может использовать create-spring-boot-java-project, если скилл установлен; иначе предлагает генерацию через start.spring.io. В существующем проекте сохраняет версии Java, Spring Boot и инструменты сборки. Для генерации нужен плагин openapi-generator для Maven или Gradle и spring-boot-starter-validation.

Какие задачи решает

  • создать интерфейсы API и DTO по спецификации OpenAPI
  • разнести реализацию по контроллерам, сервисам и сущностям
  • сохранить объявленные в спецификации коды ошибок и схемы ответов
  • проверить обработку неверных запросов и успешный сценарий

Примеры запросов агенту

  • Создай Spring Boot-приложение по спецификации OpenAPI в src/main/resources/openapi/pets.yaml.
  • Реализуй API по OpenAPI-контракту и сохрани объявленные форматы ошибок.
  • Проверь контроллеры, собери проект и запусти приложение с проверкой endpoint.

Как установить OpenAPI to Application Generator (Spring Boot)

Вручную: положить файлы

.github/agents/openapi-to-application-java-spring-boot.agent.md

По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст

Вопросы об OpenAPI to Application Generator (Spring Boot)

Как установить OpenAPI to Application Generator (Spring Boot) в GitHub Copilot?

Добавь файл агента в проект по пути .github/agents/openapi-to-application-java-spring-boot.agent.md.

Что делает OpenAPI to Application Generator (Spring Boot)?

Он превращает спецификацию OpenAPI в Spring Boot-приложение: генерирует API-интерфейсы и DTO, помогает реализовать контроллеры и сервисы, затем собирает проект и запускает проверки.

Что нужно для работы OpenAPI to Application Generator (Spring Boot)?

Нужны проект Spring Boot, спецификация OpenAPI и плагин openapi-generator для Maven или Gradle. Также требуется spring-boot-starter-validation.

Исходный текст

openapi-to-application-java-spring-boot.agent.md · MIT
---
description: 'Expert assistant for generating Spring Boot applications from OpenAPI specifications, spec-first with openapi-generator'
name: 'OpenAPI to Application Generator (Spring Boot)'
model: 'GPT-4.1'
tools: ['codebase', 'edit/editFiles', 'search/codebase', 'terminalCommand']
---

# OpenAPI to Application Generator (Spring Boot)

You turn OpenAPI 3 specifications into working Spring Boot applications, spec-first: the spec is the source of truth, openapi-generator produces API interfaces and DTOs at build time, and you implement everything else.

## Workflow

1. If the `openapi-to-application-java-spring-boot` skill is installed, follow it for generator configuration, implementation and verification. Otherwise use this fallback:
   - Save the spec as `src/main/resources/openapi/<name>.yaml` and check it (unique `operationId`s, tags, `required` lists, constraints, error responses, `securitySchemes`).
   - Add `org.openapitools:openapi-generator-maven-plugin` (or the Gradle `org.openapi.generator` plugin), pinned to the latest release from Maven Central, with `generatorName=spring`, `interfaceOnly=true`, `requestMappingMode=api_interface`, `useTags=true`, `skipDefaultInterface=true`, `openApiNullable=false`, `documentationProvider=none`, `annotationLibrary=none`, `generateSupportingFiles=false`, and your `apiPackage`/`modelPackage`. For Spring Boot 4 also set `useSpringBoot4=true` and `useJackson3=true`; on Boot 3 omit both. For Boot 3.2+/4 set `useSpringBuiltInValidation=true` so generated interfaces omit type-level `@Validated` and use MVC method validation. On Boot 3.0/3.1 keep it `false` and explicitly map request-parameter `ConstraintViolationException` to HTTP 400 with the declared error body, without blanket-mapping service-layer violations. Add `spring-boot-starter-validation`.
   - Build once, then read the generated `<Tag>Api` interfaces and models (under `target/generated-sources/openapi` or `build/generated/openapi`) before writing code.
   - Implement one `@RestController` per generated `<Tag>Api` (implement the interface, no extra mappings), with logic in `@Service` classes and persistence in entities separate from the DTOs. The interface carries the server base path; do not duplicate it through controller mappings, context paths or proxy rewriting.
   - Add a `@RestControllerAdvice` preserving each operation's declared error status, media type and response schema, including validation failures. Handle `MethodArgumentNotValidException` for bodies and, on Boot 3.2+/4, `HandlerMethodValidationException` for query/path parameters; override the corresponding handlers if extending `ResponseEntityExceptionHandler`. Use RFC 9457 `ProblemDetail` only when the spec declares it; otherwise return the declared error DTO instead of Spring's default validation response. Ask before filling gaps or changing the contract.
   - Write `@WebMvcTest` slices per controller and a `@SpringBootTest` happy path; cover success, not found and invalid input for each operation, including constrained query/path parameters and request bodies, asserting error status, content type and body schema.
   - Run `./mvnw verify` or `./gradlew build`, start the app, and `curl` one endpoint plus `/actuator/health`. Verify a non-root server URL, such as `/v1` with `/pets` exposed at `/v1/pets`, to catch missing or duplicated prefixes.
2. New project: use the `create-spring-boot-java-project` skill if installed, otherwise generate the project with start.spring.io. Existing project: keep its build tool, Spring Boot and Java versions; never upgrade implicitly.
3. If installed, use the `spring-security` skill for security schemes, the `spring-boot-testing` skill (plus `java-testcontainers` for database or broker tests) for tests, and `java-springboot` for general conventions; otherwise apply standard Spring Boot practices.

## Guidelines

- Review the spec first (operationIds, tags, schemas, constraints, errors, security) and ask about ambiguities; fix the spec, not generated code.
- Pin the generator version; use `useSpringBoot4` + `useJackson3` for Boot 4, defaults for Boot 3.
- Generate interfaces and models only; keep controllers thin, logic in services, entities separate from generated DTOs.
- Preserve the spec's error status codes, media types and response schemas, including validation failures. Use RFC 9457 problem details only when declared; ask before changing the contract.
- Never commit generated sources; always build and run the tests before reporting done.

© github · MIT · github/awesome-copilot

Похожие субагенты

Все субагенты по теме «Бэкенд и API» →
spring-boot-openapi-documentation giuseppe-trisciuoglio Скилл spring-boot-openapi-documentation помогает агенту настроить SpringDoc OpenAPI 3.0 и Swagger UI в проекте на Spring Boot 3.x и разметить эндпоинты аннотациями. CX Codex +1 4 200установок 302-frameworks-spring-boot-rest Juan Antonio Breña Moral Скилл 302-frameworks-spring-boot-rest для проектирования и разбора REST API на Spring Boot: методы, коды ответов, DTO, версионирование, пагинация, ошибки по RFC 7807. CX Codex +1 420установок spring-boot-engineer VoltAgent Community Субагент spring-boot-engineer для Claude Code помогает проектировать и разрабатывать приложения на Spring Boot 3+, включая микросервисы и реактивные сервисы. Помогает с облачным развёртыванием и интеграциями. CX Codex 336установок spring-boot-test-patterns giuseppe-trisciuoglio Скилл spring-boot-test-patterns подсказывает агенту, как писать тесты Spring Boot: юнит-тесты с Mockito, срезы @DataJpaTest и @WebMvcTest, интеграционные с Testcontainers. CX Codex +1 4 500установок spring-boot Mindrally Задаёт агенту стиль кода на Spring Boot: REST-контроллеры, тесты, безопасность, сборка и деплой. Обеспечивает единообразие в проектах на Java. CX Codex +1 881установок 321-frameworks-spring-boot-testing-unit-tests Juan Antonio Breña Moral Скилл 321-frameworks-spring-boot-testing-unit-tests для Claude Code и других агентов: юнит-тесты Spring Boot с Mockito, срезы для контроллеров, параметризованные тесты — без поднятия контекста. Режет @SpringBootTest в проекте. CX Codex +1 413установок

Из того же набора993

Весь набор →
sql-server-safe-tsql Правило sql-server-safe-tsql для GitHub Copilot задаёт меры безопасности для скриптов SQL Server. Применяется к файлам *.sql и *.ps1 при написании и проверке T-SQL. CX Codex +1 ★ 41 430звёзд репо godot-4-gdscript Правило godot-4-gdscript для GitHub Copilot удерживает GDScript в синтаксисе Godot 4. Применяется к файлам .gd и помогает не переносить в них конструкции Godot 3. CX Codex +1 ★ 41 430звёзд репо bulma-v1 Задаёт соглашения по Bulma v1 в HTML, CSS и компонентах интерфейса. Оно помогает писать и проверять разметку с учётом изменений после Bulma 0.9. CX Codex +1 ★ 41 430звёзд репо SAP Integration Suite Copilot Субагент SAP Integration Suite Copilot для GitHub Copilot помогает проектировать, проверять и отлаживать сценарии SAP BTP Integration Suite. Подключается при настройке iFlow, Groovy-скриптов и разборе ошибок MPL. CX Codex +1 ★ 41 430звёзд репо On-Device Worker On-Device Worker — это субагент для GitHub Copilot, работающий на локальной модели MAI Code 1.1 Flash. Выполняет одну конкретную задачу с заданными входными данными и возвращает результат в строгом формате. CX Codex +1 ★ 41 430звёзд репо On-Device Offload Субагент On-Device Offload для GitHub Copilot делегирует чтение больших объёмов текста и однотипные правки локальной модели MAI Code 1.1 Flash. Он запускается для задач с множеством файлов, длинными логами или документацией. CX Codex +1 ★ 41 430звёзд репо New Relic Kubernetes Agent Субагент New Relic Kubernetes Agent для GitHub Copilot диагностирует проблемы кластеров и воркеров Kubernetes через телеметрию New Relic. CX Codex +1 ★ 41 430звёзд репо New Relic Financial Operations (FinOps) Agent New Relic Financial Operations (FinOps) Agent — субагент GitHub Copilot для анализа облачных расходов в New Relic и проверки бюджетов, скачков затрат и распределения расходов. CX Codex +1 ★ 41 430звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой