К основному содержанию
субагент CX Codex

openapi-expert — субагент для Claude Code: что делает и как установить

Субагент openapi-expert для Claude, который проектирует и проверяет OpenAPI-спецификации: контракты, схемы, коды ответов, документация по эндпоинтам.

MIT ★ 1 029 обновлён 2025-10-15

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/agents/openapi-expert.md
Открыть на GitHub

Что делает openapi-expert

Субагент ведёт API-контракт по шагам: сначала общий обзор дизайна, потом разбивка на модульные части, описание путей и параметров, схемы для сложных моделей данных. Поддерживает OpenAPI 3.0 и 3.1, следит за тем, чтобы HTTP-методы совпадали с действиями над ресурсами, а коды ответов были уместными.

На выходе — файлы спецификации в YAML или JSON, документация по эндпоинтам, диаграммы, клиентские SDK из спецификации, changelog версий и тесты, сверяющие живой API с контрактом. Отдельно разбирает схемы безопасности и форматы ошибок.

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

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

  • собрать спецификацию OpenAPI 3.1 для нового сервиса
  • привести HTTP-методы и коды ответов к логике ресурсов
  • описать схемы безопасности и форматы ошибок
  • сгенерировать клиентский SDK из готовой спецификации
  • прогнать тесты API против контракта

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

  • Проверь openapi.yaml на соответствие OpenAPI 3.1 и перечисли ошибки валидации.
  • Опиши эндпоинты /orders и /orders/{id} в спецификации, добавь примеры ответов и коды ошибок.
  • Сгенерируй клиентский SDK и запись в changelog из текущей спецификации.

Как установить openapi-expert

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

.claude/agents/openapi-expert.md

Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

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

Вопросы об openapi-expert

Как установить openapi-expert в Claude Code?

Положите файл субагента по пути .claude/agents/openapi-expert.md в проекте — Claude подхватывает агентов из этой папки.

Что делает openapi-expert?

Проектирует и документирует API по спецификации OpenAPI: пути, параметры, схемы данных, безопасность. Заодно готовит SDK, changelog и тесты, сверяющие API с контрактом.

С какими версиями OpenAPI он работает?

С OpenAPI 3.0 и 3.1. Для валидации схем запросов и ответов использует JSON Schema.

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

openapi-expert.md · MIT
---
name: openapi-expert
description: Expert in designing, documenting, and optimizing APIs using OpenAPI specifications.
model: claude-sonnet-4-20250514
---

## Focus Areas

- Understanding OpenAPI 3.0 and 3.1 specifications
- Designing clear, concise, and reusable API contracts
- Ensuring proper use of HTTP methods and status codes
- Crafting comprehensive endpoint documentation
- Implementing security schemes and authentication
- Leveraging JSON Schema for request/response validation
- Versioning strategies for API evolution
- Utilizing tools for OpenAPI editing and validation
- Documenting error handling and response formats
- Encouraging RESTful design principles

## Approach

- Begin with creating a high-level API design overview
- Break down API into modular components
- Define paths and operations with appropriate parameters
- Use schema definitions to represent complex data models
- Incorporate examples for request and response bodies
- Validate OpenAPI documents with linters and tools
- Iterate based on feedback from stakeholders
- Automatically generate client SDKs from specifications
- Test APIs against OpenAPI contracts automatically
- Update documentation with each API change

## Quality Checklist

- All paths and operations are accurately documented
- HTTP methods align with resource actions
- Appropriate status codes for each API response
- Security requirements are clearly defined
- API specifications pass validation without errors
- Examples for all possible responses are provided
- Consistent use of naming conventions and styles
- Deprecation and versioning are managed systematically
- Comprehensive documentation for errors
- Clear instructions for client integration

## Output

- OpenAPI specification files in YAML or JSON format
- Detailed API documentation generated from specs
- Visual API diagrams and endpoint summaries
- Client SDKs generated from OpenAPI definitions
- Changelogs for API updates and version changes
- Automated tests for API contract verification
- Security audit reports for API vulnerabilities
- Guides for on-boarding new API users
- Samples for common API use cases
- Issues and recommendations log for continuous improvement

© 0xfurai · MIT · 0xfurai/claude-code-subagents

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

Все субагенты по теме «Бэкенд и API» →
openapi oakoss Настраивает агента на проектирование спецификаций OpenAPI 3.1 и генерацию TypeScript-клиентов. Помогает писать схемы контрактов и документацию для REST API. CX Codex +1 197установок openapi-spec-writer curiositech Скилл openapi-spec-writer проектирует спецификации OpenAPI 3.0 и 3.1 для REST API. Помогает составить схемы данных и настроить документацию ещё до написания серверного кода. CX Codex +1 175установок 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установок OpenAPI Schema slimslenderslacks MCP-сервер OpenAPI Schema для разбора спецификаций OpenAPI в формате JSON и YAML. Помогает модели исследовать эндпоинты, параметры и схемы ответов прямо в диалоге. CX Codex +1 openapi-to-application-go официальный Awesome Copilot Community Плагин openapi-to-application-go генерирует готовые к запуску приложения на Go из спецификаций OpenAPI. Он настраивает структуру проекта, хэндлеры и middleware для REST API. ★ 41 430звёзд репо go-openapi eduardo-sl Скилл go-openapi настраивает подход spec-first для REST API на Go: генерирует интерфейсы через oapi-codegen, подключает middleware валидации и отслеживает ломающие изменения схемы. CX Codex +1 ★ 90звёзд репо

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

Весь набор →
actix-expert Субагент actix-expert помогает проектировать Actix-приложения на Rust: от маршрутов и middleware до обработки ошибок, тестов и профилирования. CX Codex ★ 1 029звёзд репо elixir-expert Субагент elixir-expert для Elixir: разбирает код на OTP, GenServer и Phoenix, проверяет тесты на ExUnit и предупреждения Dialyzer. CX Codex ★ 1 029звёзд репо grafana-expert Субагент grafana-expert настраивает дашборды Grafana, оптимизирует запросы к метрикам и выстраивает алерты с каналами оповещений. CX Codex ★ 1 029звёзд репо opensearch-expert Субагент opensearch-expert помогает настраивать кластеры OpenSearch, индексы и запросы. Подключайте его для разбора проблем производительности, масштабирования и безопасности. CX Codex ★ 1 029звёзд репо kubernetes-expert Субагент kubernetes-expert проектирует манифесты Kubernetes, настраивает автомасштабирование и помогает расследовать сбои в кластере. Полезен при подготовке контейнерных сервисов к запуску. CX Codex ★ 1 029звёзд репо ocaml-expert Субагент ocaml-expert помогает писать, проверять и рефакторить OCaml-код с опорой на типовую систему, функциональный стиль и анализ производительности. CX Codex ★ 1 029звёзд репо tauri-expert Субагент tauri-expert для Tauri-приложений: разбирает конфигурацию, команды Rust, IPC и фронтенд, проверяет сборку по чек-листу. CX Codex ★ 1 029звёзд репо fastify-expert Субагент fastify-expert настраивает бэкенд на Fastify, описывает схемы валидации и управляет хуками жизненного цикла. Пригодится при сборке модульных API на Node.js. CX Codex ★ 1 029звёзд репо

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

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