Habilidades api-documentation-generator
📚

api-documentation-generator

Seguro

Generar Documentación Profesional de API

También disponible en: CrazyDubya

Deja de escribir documentación de API manualmente y mantenerla desactualizada. Esta skill genera automáticamente documentación completa y amigable para desarrolladores desde tu base de código con ejemplos funcionales.

Soporta: Claude Codex Code(CC)
📊 70 Adecuado
1

Descargar el ZIP de la skill

2

Subir en Claude

Ve a Configuración → Capacidades → Skills → Subir skill

3

Activa y empieza a usar

Pruébalo

Usando "api-documentation-generator". Documentar un endpoint POST /users que crea cuentas de usuario

Resultado esperado:

  • ## Crear Usuario
  • Crea una nueva cuenta de usuario.
  • Endpoint: POST /api/v1/users
  • Autenticación: Requerida (token Bearer)
  • Cuerpo de Solicitud: email (requerido), password (requerido, mín 8 caracteres), name (requerido)
  • Respuesta de Éxito: 201 Created con objeto de usuario incluyendo id, email, name, createdAt
  • Respuestas de Error: 400 Validation Error, 409 Email Exists, 401 Unauthorized
  • Ejemplos proporcionados en cURL, JavaScript fetch y Python requests

Usando "api-documentation-generator". Documentar consulta GraphQL GetUser con parámetro ID

Resultado esperado:

  • ## Consulta de Usuario
  • Obtiene información del usuario por ID.
  • Consulta: GetUser($id: ID!) devuelve objeto de usuario con id, email, name, role, posts
  • Variables: id (requerido, tipo ID)
  • Respuesta: Objeto Data conteniendo usuario con array de posts anidado
  • Errores: USER_NOT_FOUND con código de extensión y userId

Auditoría de seguridad

Seguro
v1 • 2/24/2026

This skill is a documentation generator that produces API documentation from codebases. Static analysis flagged 65 external_commands and 12 network patterns, but all are FALSE POSITIVES. The SKILL.md file contains only instructional markdown with code examples formatted using markdown backticks (not shell execution). URLs are documentation examples (api.example.com), not actual network calls. No executable code, no cryptographic implementations, and no system commands exist. Safe for publication.

1
Archivos escaneados
487
Líneas analizadas
0
hallazgos
1
Auditorías totales
No se encontraron problemas de seguridad
Auditado por: claude

Puntuación de calidad

38
Arquitectura
100
Mantenibilidad
87
Contenido
21
Comunidad
100
Seguridad
91
Cumplimiento de la especificación

Lo que puedes crear

Documentación de API REST

Genera documentación completa de endpoints para APIs REST con ejemplos de solicitud/respuesta, detalles de autenticación y códigos de error

Documentación de Esquema GraphQL

Crea documentación de consultas y mutaciones con especificaciones de variables, estructuras de respuesta y formatos de error

Contenido para Portal de Desarrolladores

Produce documentación de referencia completa de API incluyendo guías de inicio, configuración de autenticación y directrices de uso

Prueba estos prompts

Documentación Básica de Endpoint 
Documenta este endpoint de API: [pegar código]. Incluye el método HTTP, ruta de URL, parámetros de solicitud, formato de respuesta y un ejemplo de código.
Referencia Completa de API 
Genera documentación completa de API para esta base de código: [pegar archivos]. Incluye todos los endpoints, requisitos de autenticación, esquemas de solicitud/respuesta, códigos de error y ejemplos de código en cURL, JavaScript y Python.
Generación de Especificación OpenAPI 
Convierte este código de API en una especificación OpenAPI 3.0: [pegar código]. Incluye todas las rutas, componentes, esquemas de seguridad y valores de ejemplo.
Actualización de Documentación desde Cambios de Código 
Actualiza la documentación de API basándote en estos cambios de código: [mostrar diff]. Identifica nuevos endpoints, parámetros modificados y formatos de respuesta cambiados. Proporciona secciones de documentación actualizadas.

Mejores prácticas

  • Mantener la documentación cerca del código usando comentarios o anotaciones para asegurar que permanezcan sincronizados
  • Incluir ejemplos de código funcionales probados contra un entorno de sandbox o staging
  • Documentar todos los códigos de error y casos límite, no solo escenarios exitosos

Evitar

  • Escribir ejemplos de documentación con datos de marcador como foo y bar en lugar de valores realistas
  • Documentar solo escenarios de camino feliz sin cubrir el manejo de errores
  • Crear documentación como un artefacto separado que se olvida cuando el código cambia

Preguntas frecuentes

¿Qué lenguajes de programación soporta esta skill?
Esta skill puede documentar APIs escritas en cualquier lenguaje. Genera ejemplos de documentación en cURL, JavaScript, Python y otros lenguajes según sea necesario.
¿Puede generar especificaciones OpenAPI/Swagger?
Sí. Proporciona tu código de API y esta skill generará un archivo de especificación OpenAPI 3.0 válido que puede usarse con Swagger UI o herramientas similares.
¿Esta skill prueba los endpoints documentados?
No. Esta skill genera documentación desde análisis de código pero no ejecuta ni valida los endpoints. Prueba los ejemplos en tu entorno de staging.
¿Puede documentar APIs GraphQL?
Sí. Esta skill documenta consultas, mutaciones y suscripciones de GraphQL con especificaciones de variables, estructuras de respuesta y formatos de error.
¿Cómo mantengo la documentación actualizada cuando mi API cambia?
Ejecuta esta skill nuevamente con tu código actualizado. Para mejores resultados, integra la generación de documentación en tu pipeline de CI/CD.
¿Puede crear colecciones Postman?
Sí. Esta skill puede generar archivos JSON de colección Postman que incluyen todos los endpoints documentados con solicitudes de ejemplo.

Detalles del desarrollador

Autor

sickn33

Licencia

MIT

Repositorio

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation-generator

Ref.

main

Estructura de archivos

📄 SKILL.md