Documentación de APIs (OpenAPI/Swagger)
Contract-First Design
Los desarrolladores odian documentar, pero una API sin documentación es inútil. El estándar OpenAPI (Swagger) permite describir tu API de forma que las máquinas y los humanos la entiendan.
Automatiza el aburrimiento
Este prompt toma tu código ‘sucio’ y genera la especificación YAML perfecta para que otros equipos puedan consumir tu API sin preguntarte cada 5 minutos.
PROMPT INTERACTIVO
Actúa como Technical Writer y Backend Developer.
Analiza el siguiente código de un endpoint (controlador/ruta):
‘[Pegar Código del Endpoint]’
Genera la especificación OpenAPI 3.0 (Swagger) en formato YAML.
Debe incluir:
1. Resumen y Descripción del endpoint.
2. Parámetros de entrada (Path, Query, Body) con sus tipos de datos.
3. Respuestas posibles:
– 200 OK (con esquema de ejemplo de respuesta JSON).
– 400 Bad Request (validación).
– 401 Unauthorized.
– 500 Server Error.
Autoría y colaboración técnica
Reparto de carga operativa
Miguel Ángel Navarro: 82%
Kanon System Arquitect: 18%