API Documentation Generator

Documenta rutas de API existentes en markdown/OpenAPI; no genera código de punto final nuevo.

Por huangjia2019 · huangjia2019/claude-code-engineering

Funciona con configuración ★ 8.0/10

API Documentation Generator — Documenta rutas de API existentes en markdown/OpenAPI; no genera código de punto final nuevo.

Qué hace

Escanea los manejadores de rutas existentes (Express, FastAPI, Spring Boot, Go) para método, ruta, parámetros y autenticación, luego completa una plantilla bundled endpoint.md en documentación markdown o una especificación OpenAPI 3.0; incluye un escáner real detect_routes.py y un verificador validate_openapi.sh que se ejecutan de forma independiente. Su propio frontmatter exagera: dice 'usar cuando el usuario quiera crear nuevos puntos finales de API, generar manejadores de rutas, estructurar APIs REST', pero el cuerpo solo documenta puntos finales que ya existen — no hay paso de generación de código. Las plantillas bundled/openapi.yaml tampoco son YAML válidas tal como se envían; sus tokens {PLACEHOLDER} son literales, por lo que su propio validador lo rechaza hasta que los complete.

Informe de la prueba

Ejecuté los scripts bundled en la práctica: detect_routes.py encontró correctamente las 4 rutas en dos archivos de prueba, pero validate_openapi.sh falló en las propias plantillas del skill/openapi.yaml — sus tokens {PLACEHOLDER} son claves de mapeo de flujo YAML inválidas, por lo que la plantilla bundled falla el validador bundled hasta que la complete manualmente primero. (Listado aquí bajo nuestro nombre anterior; el propio nombre de la habilidad es "API Documentation Generator".)

Probado el: 2026-07-14 · Claude Code 2.x (agent harness)

Instalación

git clone https://github.com/huangjia2019/claude-code-engineering
cd claude-code-engineering
mkdir -p ~/.claude/skills
cp -r 04-Skills/projects/05-api-generator ~/.claude/skills/api-docs-generator

Comandos y prompts de ejemplo

  • /api-docs-generatorDocumenta rutas de API existentes en markdown/OpenAPI; no genera código de punto final nuevo.

Los skills se activan con peticiones en lenguaje natural, sin comandos que memorizar. Tras instalarlo, prompts como estos lo activan (en inglés):

  • Generate reference docs from these route handlers
  • Document this API's endpoints from the schema files
  • Produce endpoint documentation for my REST API code