From alfred-dev
Generates API documentation for endpoints including HTTP methods, parameters, request bodies, responses, error codes, and curl examples. Outputs Markdown or OpenAPI/Swagger.
npx claudepluginhub 686f6c61/alfred-dev --plugin alfred-devThis skill uses the workspace's default tool permissions.
Este skill genera documentación completa de una API, cubriendo cada endpoint con sus parámetros, respuestas, códigos de error y ejemplos de uso. La documentación de API es el contrato entre el backend y sus consumidores (frontend, servicios externos, desarrolladores de terceros); si está mal documentada, genera confusión, bugs y soporte innecesario.
Generates API documentation from codebases, including endpoints, parameters, examples, auth, errors, and OpenAPI specs for REST, GraphQL, and WebSocket APIs. Use for new APIs, updates, or onboarding.
Generates developer-facing API docs from raw specs, Postman collections, or endpoint details. Produces Markdown or OpenAPI YAML with summaries, params, examples, auth, responses, and errors.
Generates API docs from code or OpenAPI specs with examples, schemas, interactive Swagger UI/Redoc, and exports to Markdown, PDF, Postman, SDKs.
Share bugs, ideas, or general feedback.
Este skill genera documentación completa de una API, cubriendo cada endpoint con sus parámetros, respuestas, códigos de error y ejemplos de uso. La documentación de API es el contrato entre el backend y sus consumidores (frontend, servicios externos, desarrolladores de terceros); si está mal documentada, genera confusión, bugs y soporte innecesario.
El formato puede ser Markdown para documentación legible o OpenAPI (Swagger) para documentación interactiva y generación automática de clientes.
Identificar los endpoints a documentar. Revisar el código del proyecto para listar todas las rutas expuestas. Agruparlas por recurso o dominio funcional.
Para cada endpoint, documentar:
/users/{id}).Cubrir los códigos de respuesta principales:
| Código | Significado | Cuándo se devuelve |
|---|---|---|
| 200 | OK | Petición exitosa (GET, PUT, PATCH) |
| 201 | Created | Recurso creado exitosamente (POST) |
| 204 | No Content | Operación exitosa sin cuerpo de respuesta (DELETE) |
| 400 | Bad Request | Datos de entrada inválidos |
| 401 | Unauthorized | Falta autenticación o token inválido |
| 403 | Forbidden | Autenticado pero sin permisos |
| 404 | Not Found | Recurso no existe |
| 409 | Conflict | Conflicto con el estado actual (duplicado, versión desactualizada) |
| 422 | Unprocessable Entity | Datos válidos pero no procesables por reglas de negocio |
| 429 | Too Many Requests | Rate limit excedido |
| 500 | Internal Server Error | Error inesperado del servidor |
Incluir ejemplos con curl. Para cada endpoint, al menos un ejemplo funcional:
curl -X POST https://api.ejemplo.com/users \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"name": "Ana", "email": "ana@ejemplo.com"}'
Documentar códigos de error personalizados. Si la API devuelve errores con códigos propios, listarlos con su significado y la acción recomendada para el consumidor.
Si se usa OpenAPI, generar el fichero de especificación. Formato YAML o JSON compatible con OpenAPI 3.x. Incluir schemas reutilizables en components/schemas.
Verificar la documentación contra el código. Comprobar que cada endpoint documentado existe en el código y que los parámetros y respuestas coinciden. La documentación desactualizada es peor que no tener documentación.