Programación

Documenta una API sin adivinar su contrato

Crea documentación de endpoints con ejemplos sintéticos, pruebas de contrato y lagunas explícitas a partir del código disponible.

Por Equipo editorial · Funciona con Cualquier modelo

Probado conClaude Opus 5.5GPT-6 Astra

Datos que te pide

  • Audiencia
  • Contrato

El prompt

Documenta esta API para audiencia usando solo el código o la especificación disponible:

contrato

Entrega:
1. Una ficha por endpoint con método, ruta, autenticación, parámetros, cuerpo, respuesta y errores documentados. Marca como «por confirmar» cualquier comportamiento que no pueda deducirse (valores por defecto, códigos no indicados, formato de los errores, mecanismo de sesión).
2. Ejemplos de petición y respuesta sintéticos que respeten los tipos y límites observados, etiquetados como «ejemplo ilustrativo». Si te doy una respuesta realmente capturada, etiquétala aparte.
3. Una secuencia mínima de uso de principio a fin.
4. Pruebas de contrato para los casos más importantes, con entrada y resultado esperado, incluidos los límites de validación.
5. Una lista final de lagunas y contradicciones, con la pregunta que resolvería cada una.

No inventes endpoints, campos, códigos HTTP ni garantías de idempotencia. Si el código y la documentación se contradicen, muestra la discrepancia antes de elegir una interpretación.
  1. Si quieres, rellena los huecos con tus datos (o déjalos y cópialo igual).
  2. Copia el prompt.
  3. Pégalo en ChatGPT, Claude, Gemini u otra IA.

Más prompts de Programación

Aprende a escribir tus propios prompts en el blog