Escribir una referencia de API útil
Prompt que convierte código y ejemplos en una referencia por endpoint con códigos de error y llamadas que funcionan. Cópielo en la herramienta de IA que prefiera, que luego escribe la referencia de la API.
- Tipo
- Prompt
- Nivel
- Intermedio
- Tiempo
- aprox. 10 min
Los resultados dependen de la herramienta, del modelo y de lo que escriba.
Vista previa del resultado
Ejemplo: escrito por nuestra redacción, no es una respuesta real de IA.
## POST /pedidos Crea un pedido. | Campo | Tipo | Obligatorio | Nota | | cliente_id | texto | sí | de GET /clientes | | lineas | lista | sí | al menos 1 | | cupon | texto | no | mayúsculas | Errores: 409 = cupón ya usado → reenviar sin cupón Pregunta abierta: ¿el límite de 100 llamadas por minuto es por clave o por cuenta?
Rellenar
Lo que escriba se queda en esta ventana del navegador. No guardamos ni enviamos nada.
- API REST de una tienda en línea
- API interna entre dos servicios
- API para empresas socias
- API de webhooks
- API GraphQL
- código fuente de las rutas
- un archivo OpenAPI existente
- una colección de llamadas de ejemplo
- documentación antigua en texto
- solo notas del equipo
- equipos de desarrollo de clientes
- personas nuevas del propio equipo
- empresas socias sin conocimientos previos
- equipo de soporte
- equipo de frontend interno
Su prompt
Ha editado el prompt. Los cambios en los campos de arriba ya no lo sobrescriben.
Esto es una instrucción para una IA, todavía no el resultado.
Dónde funciona este prompt
Estas herramientas de IA encajan bien con este prompt:
Cómo usarlo
- Rellene los campos o toque una sugerencia. No incluya nombres, direcciones ni otros datos personales.
- Copie el prompt terminado en la herramienta de IA que prefiera.
- Entregue solo la referencia a alguien que no conozca la API. Si logra la primera llamada correcta sin preguntar, la referencia es buena.
¿Por qué funciona?
Las referencias rara vez fallan por endpoints ausentes, sino por códigos de error que faltan, campos obligatorios poco claros y ejemplos que no funcionan. Una estructura fija por endpoint y preguntas abiertas en lugar de respuestas adivinadas las hacen fiables.
Consejos
- Sustituya claves, tokens y datos de clientes en los ejemplos por marcadores antes de introducir material en la herramienta de IA.