# Api Documenter

> Especialista en documentación de API para especificaciones OpenAPI/Swagger. Se usa al documentar APIs REST o GraphQL.Chris.@ dv Roberts}]);}]);a></image_source>...>::-...>....@ff...@ ...

Fuente: https://skillsagentes.com/skills/zhaono1/agent-playbook/api-documenter
Markdown: https://skillsagentes.com/skills/zhaono1/agent-playbook/api-documenter.md

Repositorio: https://github.com/zhaono1/agent-playbook
Autor: zhaono1
Licencia: no declarada
Actualizado: el mes pasado
Coste de contexto: 27 tok instalada, 1.1k tok al activarse, 2.8k tok con todos los archivos del bundle
Bundle: 7 archivos, 11 KB
Permisos que pide: read, write, edit, bash, grep, glob

## Instalación

Un skill son archivos markdown: los mismos archivos valen para cualquier agente y lo único que cambia es el directorio de destino, es decir la bandera `--agent`. Añade `-g` para instalarlo en todos los proyectos de la máquina.

```bash
# Claude Code
npx -y skills add zhaono1/agent-playbook --skill api-documenter --agent claude-code
# Cursor
npx -y skills add zhaono1/agent-playbook --skill api-documenter --agent cursor
# Codex
npx -y skills add zhaono1/agent-playbook --skill api-documenter --agent codex
# Gemini CLI
npx -y skills add zhaono1/agent-playbook --skill api-documenter --agent gemini
# Windsurf
npx -y skills add zhaono1/agent-playbook --skill api-documenter --agent windsurf
# Cline
npx -y skills add zhaono1/agent-playbook --skill api-documenter --agent cline
```

## Qué hace

- Genera especificaciones OpenAPI/Swagger completas para APIs REST o GraphQL
- Documenta endpoints con summary, operationId, parámetros, requestBody y responses
- Documenta esquemas con referencias, descripciones, formatos y ejemplos
- Documenta requisitos de autenticación y formatos de error estándar
- Ejecuta scripts para generar y validar la especificación OpenAPI

## Cuándo usarla

- Al pedir documentar una API
- Al crear especificaciones OpenAPI/Swagger
- Cuando se necesita documentación de referencia de API
- Al mencionar "API docs"

## Qué la activa

- "Documenta esta API REST con OpenAPI"
- "Genera el spec de Swagger para mis endpoints"
- "Necesito documentación de referencia para esta API GraphQL"
- "Valida mi archivo openapi.yaml"

## Antes de instalar

- Usa scripts en Python (scripts/generate_openapi.py y scripts/validate_openapi.py) y una plantilla en references/openapi-template.yaml.
- Necesita en el PATH: python
- runs shell commands
- writes to your files
- makes network requests

## Archivos

- README.md — 784 B
- SKILL.md — 4 KB
- references/examples/README.md — 82 B
- references/examples/openapi-example.yaml — 143 B
- references/openapi-template.yaml — 69 B
- scripts/generate_openapi.py — 3 KB
- scripts/validate_openapi.py — 2 KB

## SKILL.md

No se reproduce aquí. Léelo en https://github.com/zhaono1/agent-playbook/blob/main/skills/api-documenter/SKILL.md

## Dónde encaja

- Categoría: [Desarrollo de APIs](https://skillsagentes.com/categorias/desarrollo-apis.md) — Diseña, prueba y documenta APIs HTTP y GraphQL.
- Creador: [zhaono1](https://skillsagentes.com/creators/zhaono1.md) — 0 skills en el directorio
- [Todas las skills](https://skillsagentes.com/skills.md)
- [Ranking de instalaciones](https://skillsagentes.com/ranking.md)

## Otras skills del mismo repositorio

- [Figma Designer](https://skillsagentes.com/skills/zhaono1/agent-playbook/figma-designer.md): Analiza diseños de Figma y genera PRDs listos para implementar con especificaciones visuales detalladas. Requiere conexión al servidor MCP de Figma.
- [Session Logger](https://skillsagentes.com/skills/zhaono1/agent-playbook/session-logger.md): Guarda el historial de conversación en archivos de log de sesión. Úsalo al decir '保存对话', '保存对话信息', '记录会话', 'save session' o 'save conversation'.
- [Skill Router](https://skillsagentes.com/skills/zhaono1/agent-playbook/skill-router.md): Enruta de forma inteligente las solicitudes del usuario hacia el skill de Claude Code más apropiado; es el punto de entrada por defecto cuando no está claro qué skill usar.
- [Prd Planner](https://skillsagentes.com/skills/zhaono1/agent-playbook/prd-planner.md): Crea PRDs mediante planificación persistente basada en archivos. Úsalo cuando el usuario diga explícitamente 'PRD', 'product requirements document' o '产品需求文档'.
- [Create Pr](https://skillsagentes.com/skills/zhaono1/agent-playbook/create-pr.md): Crea pull requests con revisión de documentación bilingüe, asegurando que los README en inglés y chino se mantengan sincronizados cuando cambia el catálogo de skills.

---

Skills Agentes · [Índice de páginas en markdown](https://skillsagentes.com/sitemap.md) · [Inicio](https://skillsagentes.com/index.md)