Cómo crear y desplegar una API REST con IA en Adios
Un creador de backends con IA te ayuda a definir y generar las rutas, los datos, la validación, las pruebas y la configuración del entorno de ejecución de tu aplicación. Esta guía trata de usar el agente de IA de Adios para crear y desplegar ese backend, no de llamar a una API de modelos de IA.
↗ Valida la petición y confirma juntos el movimiento y el stock.
↳ GET /inventory?product_id=MUG-01
02Lee el resultado persistido.
01Authorization: Bearer <test-token>
02200 OK
03{"product_id":"MUG-01","stock":10}
↗ Una nueva petición debe ver el mismo estado guardado.
↳ POST /movements
03Haz predecible la entrada inválida.
01{"product_id":"MUG-01","quantity":"two"}
02422 Unprocessable Content
03{"error":"invalid_quantity"}
↗ Devuelve un error útil sin cambiar el inventario.
↳ POST /movements · misma operación
04No descuentes el stock dos veces.
01Idempotency-Key: shipment-42
02200 OK · existing result
03{"movement_id":"mv_42","stock":10}
↗ La clave de reintento necesita persistencia y control en el servidor.
El ejemplo es una API de almacén con productos, movimientos de stock e inventario actual. Es lo bastante pequeña para revisarla y lo bastante completa para demostrar validación de solicitudes, escrituras en base de datos, límites de autenticación, comportamiento de errores y comprobaciones de salud. Explorar Guías de creación con IA para proyectos completos.
Ejemplo práctico / API de inventario
Escribe los ejemplos que tu API debe cumplir.
Las peticiones simuladas muestran un contrato: retirar dos tazas reduce el stock de doce a diez. Una entrada inválida no cambia nada y repetir la misma operación devuelve su resultado original. Da estos ejemplos a la IA antes de generar los controladores.
ADIOS / Sigue una petición APIEjemplo ilustrativo
POST/movementsIdempotency-Key: shipment-42
Petición del clienteProducto + cantidad{"product_id":"MUG-01","quantity":-2}
Comprobar identidadToken + permisos del recurso
Validar entradaTipos · límites · stock
Una transacciónGuardar movimiento + actualizar stock
Postgres / inventoryDatos de ejemplo
Lee el estado guardado
product_id
Antes
Después
MUG-01
12
10
Repite la misma clave → el stock se mantiene en 10.
Respuesta
201 Created
{
"movement_id": "mv_42",
"stock": 10
}
401 / 403422409
Define las respuestas de error antes de generar los controladores.
01
Haz atómicos los cambios de inventario.
Guarda el movimiento y ajusta el stock en una transacción. Prueba dos peticiones simultáneas sobre la última unidad. Una lectura seguida de una escritura sin protección puede vender más stock del disponible, aunque cada petición supere la validación por separado.
02
Trata los reintentos como tráfico normal.
Una petición puede agotar su tiempo de espera después de guardarse en el servidor. Almacena una clave de operación junto al resultado y rechaza su reutilización con otros datos. Una marca en la memoria del navegador no protege la API de reintentos de otro cliente o proceso.
03
Documenta los fallos junto a los éxitos.
Especifica autenticación, propiedad, errores de validación, paginación y límites de peticiones. Incluye solicitudes ejecutables y ejemplos de respuestas. Si cambia un campo, considera los clientes existentes antes de sustituir su nombre o tipo.
Los códigos y datos anteriores son un diseño de ejemplo. Alinea la implementación, las pruebas y la documentación con el contrato elegido; la documentación generada no demuestra que un controlador se comporte correctamente.
Publica la versión revisada y repite las pruebas de humo de salud, autenticación y escritura y lectura.
Ejemplo de creación / Stockroom API
Un backend del que pueda depender otra aplicación
El resultado tiene un contrato documentado y fallos predecibles. Una lista de endpoints sin validación, pruebas ni configuración del entorno de ejecución no es una API terminada.
Informar de la salud del proceso sin datos privados.
00
Antes del prompt
Escribe el contrato antes de generar manejadores
Empieza con los consumidores y los recursos. Eso da a la IA una razón para cada ruta, campo, código de estado y permiso, en lugar de producir una interfaz CRUD genérica.
ENTRADA / 01
Consumidor conocido
Identifica la aplicación web, la aplicación móvil, la herramienta interna o el socio que llamará a la API.
ENTRADA / 02
Propiedad de los recursos
Indica si los registros son públicos o pertenecen a un usuario, equipo o servicio.
ENTRADA / 03
Contrato de fallos
Elige un formato JSON seguro y coherente para los errores y códigos de respuesta adecuados antes de implementar.
ENTRADA / 04
Pruebas del entorno de ejecución
Mantén juntos los requisitos de inicio, puerto, salud, base de datos, secretos, migración y pruebas de humo.
Solicitar rutas, datos, permisos y pruebas antes del código
Este prompt hace que el agente inspeccione el stack existente y muestre primero el contrato de la API. Sustituye los valores entre corchetes y revisa la respuesta como las instrucciones de trabajo de la API.
Prompt de planificación de la API
Ayúdame a planificar una API REST con estructura de producción en este espacio de trabajo de Adios. No edites archivos todavía.
La API:
- Nombre: [API NAME]
- Consumidor: [WEB APP, MOBILE APP, INTERNAL TOOL, OR PARTNER]
- Recurso principal: [RESOURCE]
- Acciones principales: [CREATE, LIST, READ, UPDATE, OR OTHER ACTIONS]
- Autenticación: [NONE FOR A PUBLIC DEMO, USER TOKEN, OR SERVICE API KEY]
- Base de datos: [CURRENT PROJECT DATABASE OR POSTGRES]
Antes de proponer cambios, inspecciona el repositorio, el framework actual, el gestor de paquetes, las pruebas, la ruta de salud, la configuración del entorno y adios.yaml.
Devuelve:
1. la tabla de rutas con métodos y códigos de respuesta;
2. los formatos de solicitudes y respuestas;
3. la validación y el comportamiento de errores;
4. el modelo de datos y el enfoque de migración;
5. los límites de autenticación y autorización;
6. las consideraciones sobre límites de solicitudes o abuso;
7. las pruebas automatizadas y los ejemplos manuales de curl; y
8. la configuración necesaria de entorno de ejecución, salud, base de datos y secretos en Adios.
Prefiere el stack existente. Explica cualquier dependencia nueva. Espera mi aprobación antes de editar.
Lo que una respuesta útil contiene
Una tabla de rutas en lugar de una lista de funciones deseadas
Solicitud, respuesta, validación y formas de error
Un modelo explícito de propiedad y autorización
Requisitos del entorno de ejecución y de pruebas antes de editar
02
Implementar el contrato
Crear la API sin sustituir el stack que funciona
Tras aprobar el contrato, usa este prompt para implementarlo con errores coherentes, acceso parametrizado a datos, pruebas y ejemplos ejecutables.
Prompt de creación de la API
Crea la API REST a partir del plan que he aprobado.
Requisitos:
- Conserva el lenguaje, el framework, el gestor de paquetes y los archivos de despliegue de Adios existentes.
- Conserva un endpoint de salud ligero sin autenticación que no exponga datos privados.
- Valida cada entrada externa y devuelve un formato JSON de error coherente.
- Aplica la autenticación y la autorización en el servidor cuando el plan las requiera.
- Usa acceso parametrizado a la base de datos mediante la capa de datos establecida del proyecto.
- Añade migraciones reversibles si este repositorio utiliza migraciones.
- Nunca escribas credenciales directamente en el código. Referencia los valores de base de datos y autenticación por el nombre de la variable de entorno.
- Añade documentación concisa de la API y solicitudes de ejemplo ejecutables.
- Añade pruebas del recorrido correcto, entradas inválidas, registros ausentes, acceso no autorizado y un recorrido de fallo de base de datos que se pueda probar de forma segura.
- Ejecuta el formateador, el linter, las pruebas y el comando de compilación de producción que ya utiliza el proyecto.
Al terminar, dame la tabla de rutas, los archivos modificados, los resultados de las pruebas, la configuración necesaria en Adios y los comandos exactos que puedo ejecutar contra la vista previa. No despliegues en producción.
Lo que una respuesta útil contiene
Manejadores que coinciden con la tabla de rutas aprobada
Validación y comportamiento de error consistentes
Pruebas de éxito, fallo y control de acceso
Solicitudes de vista previa para copiar
Dentro de la plataforma
Observa los datos detrás del endpoint.
Usa el explorador de bases de datos para inspeccionar tablas y ejecutar consultas. Esta demo simulada de Adios muestra una base de datos privada, registros de ejemplo y la conexión de la app.
Probar entradas malformadas, límites de acceso y solicitudes repetidas
Una solicitud correcta demuestra poco. Este prompt de revisión comprueba el contrato desde la perspectiva de un cliente desconocido o poco fiable.
Prompt de verificación de la API
Revisa esta API como si fuera a llamarla un cliente desconocido. Corrige solo problemas verificados y no despliegues.
Comprueba:
- que las rutas usen los métodos HTTP y códigos de estado previstos;
- que las entradas malformadas, ausentes, demasiado grandes e inesperadas fallen de forma segura;
- que no se pueda eludir la autenticación y que un cliente no pueda acceder a los datos protegidos de otro;
- que las respuestas de error no expongan trazas de pila, secretos, detalles de base de datos ni rutas internas;
- que las solicitudes repetidas se comporten de forma segura cuando se requiera idempotencia;
- que las escrituras de base de datos y las migraciones sean coherentes;
- que la documentación de la API y las solicitudes de ejemplo coincidan con la implementación;
- que las comprobaciones de salud sigan siendo ligeras;
- que los registros sean útiles sin registrar credenciales ni cuerpos de solicitudes sensibles; y
- que pasen todas las comprobaciones del formateador, lint, pruebas y compilación.
Devuelve una tabla de comprobaciones y pruebas, las solicitudes exactas que debo ejecutar en la vista previa y cualquier riesgo pendiente.
Lo que una respuesta útil contiene
Pruebas negativas, no solo respuestas 200
No hay detalles internos en errores públicos
Documentación comprobada frente a la implementación
Una lista explícita de los riesgos restantes
04
Vincular el código fuente al entorno de ejecución
Comparar el contrato de la API con el contrato de publicación de Adios
El último prompt comprueba que el código fuente, la migración, el comando de inicio, el puerto, la ruta de salud, las dependencias, los secretos y las pruebas de humo describen la misma versión.
Prompt de revisión de la versión de la API
Prepara esta API para una revisión de despliegue en Adios. No despliegues hasta que lo apruebe.
Confirma el comando de inicio, el host y puerto de escucha, la ruta de salud, los nombres necesarios de variables de entorno, la dependencia de base de datos, el comando de migración y la ruta pública esperada. Compáralos con adios.yaml e informa de cualquier discrepancia.
Después dame:
1. los resultados finales de las comprobaciones automatizadas;
2. cinco solicitudes seguras de prueba de humo para la URL de vista previa;
3. una nota de reversión o recuperación para una migración fallida;
4. los secretos que debo configurar mediante Adios en lugar de incluirlos en el código fuente; y
5. una comprobación posterior al despliegue que cubra salud, registros, autenticación y un ciclo de escritura y lectura.
Detente para obtener mi aprobación antes del despliegue en producción.
Lo que una respuesta útil contiene
No hay desajuste entre el proceso y adios.yaml
Pruebas de humo seguras en la vista previa y en producción
Una nota de recuperación de la migración
Una pausa explícita antes de desplegarse
T
Prueba el resultado
Una compilación correcta es el comienzo de la revisión
Abre la vista previa y realiza tú mismo los recorridos importantes. Pide pruebas al agente, pero no confundas su resumen con tu aprobación.
PRUEBA / 01
Contrato
Cada ruta documentada, método, código de estado y campo coincide con la implementación.
Las entradas malformadas e inesperadas devuelven el mismo formato JSON seguro de error.
La paginación, el filtrado y la ordenación se comportan de forma predecible cuando están presentes.
PRUEBA / 02
Límite de confianza
Las credenciales ausentes, inválidas, caducadas o de un propietario incorrecto fallan de forma segura.
Un error público no contiene trazas de pila, secretos, detalles SQL ni rutas internas.
Los registros omiten las credenciales y los cuerpos de solicitud sensibles innecesarios.
PRUEBA / 03
Entorno de ejecución
El proceso escucha en el host declarado y el puerto.
Pasan las migraciones y las comprobaciones de salud, formateador, lint, pruebas y compilación.
Una prueba de humo de escritura y lectura funciona en la vista previa y después de publicar.
Punto de aprobación humana
Publicar juntos el contrato de la API y sus pruebas
Trata la tabla de rutas, las migraciones, los nombres de variables de entorno, la ruta de salud, los registros y las solicitudes de humo como parte de la versión. Aprueba solo cuando coincidan con la versión que se ejecuta en la vista previa.
01Ejecuta las solicitudes seguras en la vista previa y compáralas con la documentación.
02Confirma las instrucciones de migración y recuperación de la base de datos para esta versión.
03Configura los secretos por nombre en Adios y mantén sus valores fuera del código fuente.
04Verificar los ajustes de inicio, puerto, salud y dependencia en adios.yaml.
05Aprueba la versión y repite después la comprobación de salud, la autenticación y un ciclo de escritura y lectura.
?
Preguntas antes de comenzar
Lo que promete esta guía y lo que no
¿Esta guía crea una API de IA o crea mi API con IA?+
Usa el agente de IA de Adios para crear el backend de tu aplicación. La API del ejemplo gestiona datos de un almacén; no llama a un modelo de lenguaje ni expone una API de modelos de IA.
¿Qué framework de backend debería usar?+
Prefiere el framework que ya usa el repositorio. Si empiezas desde cero, elige un stack que tu equipo pueda mantener y que tenga convenciones claras de validación, pruebas, migraciones y entorno de ejecución. El prompt pide al agente que explique cualquier dependencia nueva.
¿Debe requerir autenticación un endpoint de salud de la API?+
Un endpoint de salud del proceso suele ser ligero y no requerir autenticación para que la plataforma pueda comprobarlo, pero no debe exponer secretos, registros privados, credenciales de dependencias ni detalles internos de diagnóstico.
¿Cómo sé si una API generada por IA se puede desplegar de forma segura?+
No te apoyes solo en la generación. Revisa el contrato, ejecuta pruebas positivas y negativas, verifica la autorización y los errores, inspecciona la gestión de secretos, aplica migraciones de forma segura, prueba la vista previa y aprueba tú mismo la versión candidata exacta.
Empieza con un espacio de trabajo que se pueda revisar
Da el primer prompt a Adios y aprueba después el plan.