Esta skill ayuda a los desarrolladores a crear documentación profesional de API con especificaciones OpenAPI, Swagger UI interactivo, ejemplos de código y guías de referencia para API REST y GraphQL.
Descargar el ZIP de la skill
Subir en Claude
Ve a Configuración → Capacidades → Skills → Subir skill
Activa y empieza a usar
Pruébalo
Usando "api-documentation". Create OpenAPI spec for user management API
Resultado esperado:
Una especificación OpenAPI 3.0 completa con endpoint /users, paginación, autenticación y esquemas de respuesta
Usando "api-documentation". Document the authentication flow
Resultado esperado:
Guía paso a paso: 1. Endpoint de login retorna JWT, 2. Incluir token Bearer en header Authorization, 3. Mecanismo de refresh de token, 4. Ejemplos de comandos curl
Usando "api-documentation". Define API reference structure
Resultado esperado:
Docs organizadas con: Visión General, Autenticación, Endpoints agrupados por recurso, Códigos de Error, Límites de Tasa, Registro de Cambios
Auditoría de seguridad
SeguroAll 79 static findings are false positives. The skill contains only documentation templates with example URLs and code blocks. No actual shell commands, network exfiltration, or cryptographic vulnerabilities exist. The scanner triggered on markdown code delimiters, placeholder URLs in examples, and JWT authentication mentions in OpenAPI specs.
Puntuación de calidad
Lo que puedes crear
Desarrollo de API Interna
Documentar APIs de microservicios internos para colaboración de equipos frontend-backend
Lanzamiento de API Pública
Crear documentación profesional para desarrolladores externos que consumen tu API
Documentación de SDK
Generar guías completas y documentación de referencia para consumidores de bibliotecas
Prueba estos prompts
Create an OpenAPI 3.0 specification for a REST API endpoint that manages users. Include GET (list), POST (create), GET by ID, PUT (update), DELETE endpoints. Define request/response schemas with proper HTTP status codes.
Document a protected API endpoint that requires JWT authentication. Include the auth flow, bearer token usage, 401/403 error responses, and example curl commands for authenticated requests.
Create a comprehensive error handling guide for a REST API. Document all common error codes (400, 401, 403, 404, 409, 429, 500), their meanings, example error responses, and recommended client handling approaches.
Set up Swagger UI for an Express.js API. Show how to integrate swagger-ui-express, load an OpenAPI YAML file, configure custom CSS, and mount the docs at /api-docs.
Mejores prácticas
- Proporcionar ejemplos de código funcionales en múltiples lenguajes (JavaScript, Python, curl)
- Siempre documentar casos de respuesta de éxito y error con ejemplos
- Mantener la documentación sincronizada con los cambios de API usando registros de cambios
Evitar
- Usar claves de API reales o contraseñas en código de ejemplo
- Dejar descripciones vagas como 'retorna datos' sin especificidades
- Falta de documentación de casos de error para escenarios de fallo
Preguntas frecuentes
¿Qué versión de OpenAPI soporta esta skill?
¿Puedo generar documentación para APIs GraphQL?
¿Cómo configuro Swagger UI interactivo?
¿Qué métodos de autenticación se soportan?
¿Puede esta skill probar mis endpoints de API reales?
¿Cómo documento límites de tasa?
Detalles del desarrollador
Autor
supercent-ioLicencia
MIT
Repositorio
https://github.com/supercent-io/skills-template/tree/main/.agent-skills/api-documentation/Ref.
main
Estructura de archivos
📄 SKILL.md