Skip to content
NeuralSkills
Documentacion

Escritor de Documentacion de API

Genera documentacion clara de API REST con parametros, respuestas, ejemplos y codigos de error.

Intermedio Gratis Publicado: 15 de abril de 2026
Herramientas Compatibles claude-codechatgptgeminicopilotcursorwindsurfuniversal

El Problema

La documentacion de API esta ausente, auto-generada sin contexto, o fue escrita una vez y nunca actualizada. Los desarrolladores que integran con tu API desperdician horas adivinando formatos de parametros, decodificando respuestas de error, y haciendo ingenieria inversa del comportamiento por prueba y error. Documentacion clara de API con ejemplos reales reduce el tiempo de integracion de dias a horas.

El Prompt

Eres un redactor tecnico senior de APIs. Genera documentacion integral para los siguientes endpoints de API:

ENDPOINTS:
[pega tus definiciones de rutas, codigo del controlador o especificacion OpenAPI aqui]

URL BASE: [ej. https://api.example.com/v1]
METODO DE AUTH: [ej. Bearer token, API key en header, OAuth 2.0]

Para cada endpoint, documenta:
1. **Metodo y Ruta**: ej. GET /users/:id
2. **Descripcion**: Que hace este endpoint en una oracion
3. **Autenticacion**: Nivel de auth requerido
4. **Parametros**: Tabla con nombre, ubicacion (path/query/body), tipo, requerido, descripcion
5. **Ejemplo de Request**: Comando curl completo o llamada fetch
6. **Respuesta Exitosa**: Codigo de estado, cuerpo de respuesta con datos de ejemplo realistas
7. **Respuestas de Error**: Todos los codigos de error posibles con formato del mensaje y cuando ocurren
8. **Limites de Tasa**: Si aplica

Formatea como Markdown limpio adecuado para un sitio de documentacion.

Ejemplo de Salida

## GET /users/:id

Obtener un usuario individual por su identificador unico.

**Autenticacion**: Bearer token requerido (scope: `users:read`)

### Parametros

| Nombre | En | Tipo | Requerido | Descripcion |
|--------|-----|------|-----------|-------------|
| id | path | string (UUID) | si | Identificador unico del usuario |
| fields | query | string | no | Campos separados por coma a incluir |

### Request

curl -H "Authorization: Bearer TOKEN" \
  https://api.example.com/v1/users/abc-123?fields=name,email

### 200 OK

{ "id": "abc-123", "name": "Maria Garcia", "email": "maria@example.com" }

### Errores

| Estado | Codigo | Descripcion |
|--------|--------|-------------|
| 401 | UNAUTHORIZED | Bearer token faltante o invalido |
| 404 | USER_NOT_FOUND | No existe usuario con el ID proporcionado |
| 429 | RATE_LIMITED | Excedio 100 peticiones por minuto |

Cuando Usar

Usa este skill cuando construyas una nueva API, incorpores desarrolladores externos, o documentes una API existente que solo vive en el codigo. Alimentalo con tus archivos de rutas o codigo de controlador para los mejores resultados. Tambien util cuando conviertas conocimiento interno de API en un portal publico para desarrolladores.

Tips Pro

  • Pega el codigo real del route handler — la IA extrae validacion de parametros, manejo de errores y formas de respuesta directamente de la implementacion, capturando detalles que podrias olvidar documentar.
  • Solicita una especificacion OpenAPI — agrega “Tambien genera el YAML OpenAPI 3.0 para estos endpoints” para producir documentacion legible por maquinas junto con el Markdown legible para humanos.
  • Incluye el flujo de autenticacion — agrega “Documenta el flujo completo de auth desde obtener un token hasta hacer un request autenticado” para que los desarrolladores puedan ir de cero a llamada API funcionando.