# api-testing-observability-api-documenter

Субагент пишет документацию API: спецификации OpenAPI 3.1, интерактивные примеры, SDK и порталы для разработчиков. Пригодится, когда API есть, а описания к нему нет.

- субагент · `type=agent` · Claude Code, Codex, Cursor · ★ 41729
- Автор: Seth Hobson
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/wshobson/agents/tree/HEAD/plugins/api-testing-observability/agents/api-documenter.md
- Обновлён: 2026-10-24
- HTML: https://affpapa.org/nevibecode/agents/api-testing-observability-api-documenter

## Что делает

Субагент работает с OpenAPI 3.1 и AsyncAPI, схемами GraphQL и JSON Schema, документирует вебхуки и жизненный цикл API от проектирования до вывода из эксплуатации. Внутри — набор практик: генерация примеров кода на нескольких языках, сборка SDK из спецификации, настройка Swagger UI и Redoc, порталы на Docusaurus, коллекции Postman и Insomnia.

Отдельный блок — аутентификация: потоки OAuth 2.0 и OpenID Connect, работа с API-ключами, JWT и обновлением токенов, ограничения по частоте запросов. Примеры из документации субагент предлагает проверять автоматически, а mock-серверы собирать прямо из описания. Модель — `sonnet`.

Ключей API и внешних сервисов для запуска не требуется, но заявленные возможности вроде Mintlify или ReadMe AI работают только там, где эти сервисы уже подключены. Ставить есть смысл, если у вас несколько API и нужен общий портал: для одной ручки хватит и обычного README.

## Установка

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

1. **Через маркетплейс плагинов**
В чате агента (не в терминале):
```text
/plugin marketplace add wshobson/agents
```
В чате агента (не в терминале):
```text
/plugin install api-testing-observability@claude-code-workflows
```

2. **Вручную: положить файлы**
- Файл: `.claude/agents/api-documenter.md` — Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

### Codex

**Вручную: положить файлы**
- Файл: `.codex/agents/api-documenter.toml` — Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

### Cursor

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/wshobson/agents/tree/HEAD/plugins/api-testing-observability/agents/api-documenter.md

## Когда брать
- описать REST API в спецификации OpenAPI 3.1 с примерами запросов
- собрать SDK на нескольких языках из готовой спецификации
- настроить интерактивную документацию с кнопкой «попробовать»
- задокументировать потоки OAuth 2.0 и работу с JWT
- написать руководство по миграции после ломающих изменений

## Примеры запросов агенту
- Составь спецификацию OpenAPI 3.1 для этого REST API, добавь примеры авторизации
- Собери SDK из спецификации и опиши установку в README
- Задокументируй вебхуки: payload, подпись и обработка ошибок

## Похожие
- [api-documenter](https://affpapa.org/nevibecode/skills/api-documenter.md) — скилл · 717 установок
- [code-documenter](https://affpapa.org/nevibecode/skills/httpsgithubcomjeffallan-code-documenter.md) — скилл · ★ 4676
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/secondsky-api-reference-documentation.md) — скилл · 454 установки
- [adding-api-docs](https://affpapa.org/nevibecode/skills/adding-api-docs.md) — скилл · 413 установок
- [get-api-docs](https://affpapa.org/nevibecode/skills/get-api-docs.md) — скилл · 1300 установок
- [api-contract-testing](https://affpapa.org/nevibecode/skills/api-contract-testing.md) — скилл · 913 установок

Из того же набора: [wshobson/agents](https://affpapa.org/nevibecode/by/wshobson/agents.md) — 342 карточки

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

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