Una herramienta integral que genera automáticamente documentación de API amigable para desarrolladores, especificaciones OpenAPI y ejemplos de código interactivos a partir de su código fuente.
Instalar y Descargar
1. ClawHub CLI
La forma más rápida de instalar una habilidad directamente desde el registro.
npx clawhub@latest install api-doc-builder
2. Instalación manual
Copia la carpeta de la habilidad a una de estas ubicaciones
~/.openclaw/skills/ <project>/skills/ Prioridad: Espacio de trabajo > Local > Integrado
3. Instalación del prompt
Copia este prompt en OpenClaw para instalarlo automáticamente.
Ayúdame a instalar api-doc-builder usando Clawhub. Si Clawhub no está instalado, instálalo primero (npm i -g clawhub).
¿Prefieres descargar?
Obtén los archivos originales de la habilidad en un archivo ZIP.
¿Qué es API Documentation Builder?
El api-doc-builder es una herramienta de nivel profesional dentro del ecosistema Openclaw Skills diseñada para eliminar el trabajo manual involucrado en el mantenimiento de la documentación de API. Al realizar un análisis profundo de los archivos fuente locales, la skill extrae definiciones de rutas, esquemas de parámetros y requisitos de autenticación para construir una documentación sincronizada. Esto asegura que sus referencias técnicas sean siempre precisas, reflejando el estado real de su código sin requerir tediosas actualizaciones manuales.
Esta skill es compatible con una amplia gama de frameworks modernos, incluidos Express.js, Next.js, FastAPI y Gin. Transforma bases de código complejas en Markdown legible por humanos o especificaciones OpenAPI 3.0 legibles por máquina. Aprovechar Openclaw Skills para tareas de documentación permite a los desarrolladores centrarse en la creación de funciones, al tiempo que garantiza que los integradores de terceros y los equipos internos tengan acceso a referencias de API interactivas y de alta calidad.
Casos de uso de API Documentation Builder
- Nuevo desarrollo de API donde necesita documentar los endpoints a medida que los construye.
- Generación de documentación retroactivamente para microservicios heredados o herramientas internas.
- Creación de especificaciones OpenAPI para automatizar la generación de SDK de cliente.
- Creación de catálogos de API internos para mejorar la incorporación de desarrolladores y el descubrimiento de servicios.
- Preparación para el lanzamiento de un producto de API pública con documentación completa y rica en ejemplos.
- Integración con puertas de enlace de API o suites de prueba de contratos que requieren especificaciones OpenAPI válidas.
Cómo funciona API Documentation Builder
- La skill escanea su directorio de fuentes para identificar definiciones de rutas, métodos HTTP y middleware.
- Analiza las firmas de funciones e interfaces TypeScript para definir los cuerpos de solicitud y los esquemas de respuesta.
- Se analizan los comentarios JSDoc y las etiquetas específicas para incorporar descripciones y metadatos escritos por el desarrollador.
- Se utiliza la lógica de validación de librerías como Zod, Joi o Pydantic para determinar las restricciones de los parámetros.
- Se generan automáticamente ejemplos realistas de solicitudes y respuestas para ilustrar el uso de la API.
- La salida final se compila en el formato que elija, como un README en Markdown o un archivo YAML de OpenAPI 3.0.
Configuración de API Documentation Builder
Para utilizar esta skill entre sus Openclaw Skills, asegúrese de tener un entorno de desarrollo estándar con Node.js. Dado que la skill analiza archivos locales, no se requieren credenciales de API externas ni autenticación en la nube.
# Dirija al agente de IA para analizar sus rutas de API específicas
# Ejemplo de Prompt:
"Generate a comprehensive OpenAPI 3.0 specification for the routes in src\/api\/"
Puede especificar su formato de salida preferido (Markdown, JSON o YAML) e incluir instrucciones para estilos de documentación específicos, como colecciones compatibles con Swagger o listas para Postman.
Esquema de datos y taxonomía de API Documentation Builder
El api-doc-builder organiza los metadatos extraídos en una jerarquía estructurada adecuada para el descubrimiento de API. A continuación se muestra el mapeo de los elementos de código a las salidas de documentación:
| Elemento Lógico | Fuente de Extracción | Salida de Documentación |
|---|---|---|
| Rutas | Enrutadores del Framework (Express, FastAPI) | Ruta, Método HTTP, Etiquetas |
| Esquemas | Tipos TypeScript / Zod / Pydantic | Modelos de Solicitud/Respuesta |
| Seguridad | Middleware de Autenticación / etiquetas @auth | Esquemas de Seguridad (JWT, API Key) |
| Metadatos | JSDoc / Comentarios | Resúmenes y Descripciones |
| Uso | Flujo de Código | curl y Ejemplos Específicos de Lenguaje |
Los archivos generados suelen guardarse como openapi.yaml, api-reference.md o se exportan directamente a herramientas de alojamiento de documentación.
Funciones avanzadas de API Documentation Builder
- Generación de fragmentos de código en múltiples lenguajes para curl, JavaScript, Python y Go.
- Soporte de versionado automatizado que incluye generación de registros de cambios y guías de migración.
- Exportación fluida a visores de documentación interactivos como Swagger UI y Redoc.
- Soporte para lógica de validación compleja y definiciones de esquemas anidados.
- Capacidades de integración con puertas de enlace de API en la nube (AWS, Google Cloud) y colecciones de Postman.
SKILL.md
Cargando
Habilidades relacionadas de Openclaw
Skill de Cold Stone Creamery
Una skill de análisis de negocio estratégico centrada en el retail experiencial y el modelo de franquicia global de la marca Cold Stone Creamery.
AIsa Provider
La habilidad AIsa Provider permite que los entornos de ejecución de OpenClaw se conecten con la pasarela AIsa, proporcionando acceso a una amplia gama de LLMs chinos a través de una API compatible con OpenAI.
Serena Semantic Code Navigation
Serena proporciona navegación semántica de código con reconocimiento de símbolos y edición dirigida para proyectos de software complejos y de múltiples archivos.
Print Tool
Una utilidad de CLI optimizada para emitir texto formateado y valores de variables a la salida estándar para registro y depuración.
Code Review Inspector
Un auditor de código de IA automatizado que identifica vulnerabilidades de seguridad, cuellos de botella de rendimiento y errores de lógica antes de que lleguen a producción.
Aniplex Intelligence Skill
Una skill analítica especializada para comprender la lógica empresarial, las estructuras de los comités de producción y las estrategias de monetización de IP del gigante de la industria del anime Aniplex.
Presentado*
