API Documenting
Convierte código de ruta en documentación de referencia de API con tablas de parámetros, ejemplos curl, especificaciones OpenAPI
Probado · Funciona
Qué hace
Lee archivos fuente para definiciones de rutas (Express, FastAPI, Flask, Spring, Gin) y genera documentación de referencia de API utilizando plantillas fijas para las páginas de endpoints y la página de índice, además de una especificación OpenAPI 3.0 opcional. Incluye un script de Python para detección de rutas y un validador de shell para especificaciones generadas. Se activa cuando el usuario solicita documentar APIs, generar documentación de endpoints, producir una referencia de API o escribir una especificación OpenAPI/Swagger.
Informe de la prueba
Cloné el repositorio, lo instalé en un HOME temporal (nunca toqué el ~/.claude real), y confirmé que los 8 archivos que el cuerpo de SKILL.md referencia existen — PATTERNS.md, STANDARDS.md, EXAMPLES.md, templates/{endpoint,index,openapi}, scripts/{detect_routes.py,validate_openapi.sh} — obtuve tres de ellos con HTTP 200. Ejecuté scripts/detect_routes.py contra un archivo Express de 3 rutas que escribí; devolvió correctamente GET /orders, POST /orders y DELETE /orders/:orderId con números de archivo+línea, por lo que el ayudante es real y no decorativo. Tarea: documentar ese mismo orders.js. La línea base (46 líneas, 968 B) eran viñetas en prosa sin tipos, sin sección de autenticación, sin curl, sin índice; la ejecución de la habilidad (212 líneas, 3992 B) siguió templates/index.md y luego templates/endpoint.md por ruta y añadió un encabezado de URL base/autenticación, una tabla de resumen de endpoints, una tabla de códigos de respuesta comunes, tres tablas de parámetros con columnas de Ubicación/Tipo/Requerido (0 en la línea base), tres ejemplos ejecutables de solicitud/respuesta curl (0 en la línea base), el caso 401 que la línea base omitió, y una línea de Notas que solo escribí porque la plantilla forzó la sección — ese 403 se verifica después de la existencia, por lo que un ID válido propiedad de otro usuario devuelve 403 y no 404. Frases de activación juzgadas: DEBERÍA activarse — "Generar una referencia de API para las rutas en src/api/", "Escribir una especificación OpenAPI 3.0 para mi aplicación FastAPI", "Documentar todos los endpoints en este router Express" (cargó las tres); NO DEBERÍA — "Diseñar una API REST para un sistema de reservas, ¿qué endpoints debería tener?" (diseño de API, no documentar código existente) y "Escribir un README para esta herramienta CLI" (documentación pero sin endpoints); ambas rechazadas correctamente, 5/5. No hay problemas de seguridad: no curl|sh, no base64, no llamadas de red, no acceso a secretos; validate_openapi.sh solo ejecuta swagger-cli/npx/spectral si ya están presentes. Documentación penalizada un punto porque la habilidad se encuentra dentro de un proyecto de lección de curso sin un README independiente propio — el README circundante es material didáctico sobre divulgación progresiva, no documentación de uso.
Probado el: 2026-07-21 · Claude Code 2.x (agent harness)
Instalación
git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git /tmp/api-documenting-src mkdir -p ~/.claude/skills cp -R /tmp/api-documenting-src/04-Skills/projects/02-progressive-skill/.claude/skills/api-documenting ~/.claude/skills/api-documenting # No dependencies for the documentation workflow itself. # Optional helper: python3 ~/.claude/skills/api-documenting/scripts/detect_routes.py <source_dir> -> JSON list of routes (stdlib only, no pip installs) # Optional helper: bash ~/.claude/skills/api-documenting/scripts/validate_openapi.sh <spec.yaml> -> needs swagger-cli / npx / spectral, else falls back to a YAML syntax check # The repo is a Claude Code course; this skill lives in lesson project 04-Skills/projects/02-progressive-skill. No plugin marketplace entry.
Comandos y prompts de ejemplo
/api-documentingConvierte código de ruta en documentación de referencia de API con tablas de parámetros, ejemplos curl, especificaciones OpenAPI
Los skills se activan con peticiones en lenguaje natural, sin comandos que memorizar. Tras instalarlo, prompts como estos lo activan (en inglés):
Generate API reference docs for this serviceCreate an OpenAPI spec for these endpointsDocument this API's request and response formats