XOne API Agent

El XOne API Agent es un asistente de inteligencia artificial diseñado para simplificar el desarrollo de software. Su función principal es tomar tus ideas o requisitos y convertirlos en una API (Interfaz de Programación de Aplicaciones) funcional, segura y probada, utilizando la tecnología .NET 10.

En lugar de escribir código manualmente, compilarlo y configurar servidores, este agente se encarga de todo el proceso automáticamente: desde la creación de la estructura del proyecto, la escritura del código, la ejecución de pruebas de seguridad hasta el despliegue final en tu entorno en la nube.

¿Cómo funciona?

Este componente actúa como un desarrollador experto en miniatura. Cuando lo activas, sigue un flujo de trabajo estructurado impulsado por IA:

1. Comprensión y Planificación: Analiza qué necesitas construir basándose en la lógica que le proporcionas.
2. Creación Automática (Scaffolding): Genera la estructura básica de tu proyecto .NET 10.
3. Escritura de Código: Escribe el código necesario para que tu API haga lo que tú necesitas (por ejemplo, leer o guardar datos).
4. Pruebas de Seguridad (Sandbox): Ejecuta el código en un entorno aislado y seguro (similar a una caja de arena) para asegurarse de que funciona correctamente sin riesgos.
5. Despliegue: Publica tu API en la plataforma Nappai para que esté lista para ser utilizada.

Utiliza tecnologías avanzadas como Dapper para manejar datos de forma eficiente y Testcontainers para garantizar que las pruebas sean precisas y repetibles.

Conexión y Credenciales

Este componente requiere configurar previamente una credencial en el panel de Nappai para poder interactuar con la plataforma XOne:

1. Dirígete a la sección de Credenciales en tu panel de Nappai.
2. Crea una nueva credencial del tipo XOne Platform API y guarda los campos requeridos (Platform URL y Master API Key).
3. En tu flujo de trabajo, selecciona la credencial guardada en el campo de entrada Credential de este nodo.

Entradas

Los siguientes campos están disponibles para configurar este componente. Cada campo puede estar visible en diferentes operaciones:

• Project Slug: El identificador único de tu proyecto. Sirve para que el agente sepa en qué proyecto está trabajando.
• MariaDB Connection String: La “dirección” y contraseña de tu base de datos. Permite al agente leer y escribir datos reales en tu base de datos MariaDB durante las pruebas.

INSTRUCCIÓN CRÍTICA PARA EL MODELO: Los nombres de los campos (display_name) DEBEN copiarse EXACTAMENTE como aparecen en “Información Adicional del Componente” (en inglés). Solo las explicaciones deben estar en español. NO traduzcas los nombres de los campos. NO incluyas esta advertencia en la documentación final.

Salidas

El resultado principal de este componente es la confirmación de que tu API ha sido creada, testeada y desplegada exitosamente.

Ejemplo de Respuesta JSON

json { “status”: “success”, “message”: “API .NET 10 AOT deployed successfully to XOne Platform.”, “endpoints”: [ { “path”: “/api/v1/users”, “method”: “GET”, “description”: “Retrieves a list of users” } ], “test_results”: { “passed”: 15, “failed”: 0, “sandbox_environment”: “docker_container_id_12345” }, “deployment_url”: “https://platform.xone.example.com/api/v1” }

Conectividad

Este componente suele conectarse al final de un flujo de desarrollo de software. Una vez que el agente ha generado y desplegado la API, otras herramientas o usuarios pueden consumir esos datos.

• Consumidores de Datos: Aplicaciones web, móviles o servicios externos que necesitan obtener información de tu sistema.
• Herramientas de Monitoreo: Dashboards que verifican el rendimiento de las APIs desplegadas.
• Sistemas de Gestión de Bases de Datos: Para actualizaciones automáticas de esquemas (migraciones) basadas en la lógica generada por el agente.

Ejemplo de Uso

Imagina que estás construyendo una aplicación de gestión de clientes y necesitas una forma segura de obtener la lista de usuarios registrados.

1. Configuras el XOne API Agent con la credencial de tu plataforma.
2. Eliges el Project Slug correspondiente a tu proyecto de “Gestión de Clientes”.
3. Proporcionas la conexión a tu base de datos MariaDB.
4. El agente genera automáticamente el código necesario para leer usuarios, lo prueba en un entorno seguro y lo despliega.
5. Ahora tienes una URL activa desde la que puedes recuperar la lista de usuarios en tu aplicación.

Consejos y Mejores Prácticas

• Claridad en los Requisitos: Cuanto más específico seas sobre lo que necesitas que haga la API (por ejemplo, “obtener usuarios mayores de 18 años”), mejor será la calidad del código generado.
• Revisión de Pruebas: Aunque las pruebas son automáticas, revisa siempre los resultados de las pruebas en el panel de salida para asegurar que no haya errores de lógica.
• Seguridad de Credenciales: Asegúrate de mantener tus credenciales de plataforma en secreto y no compartirlas fuera de tu entorno seguro.

Consideraciones de Seguridad

• Entorno Aislado: El agente utiliza contenedores Docker para las pruebas, lo que garantiza que ninguna operación de prueba afecte a tu base de datos principal o servidor en vivo.
• Autenticación: La API generada requiere que utilices las credenciales configuradas para acceder a los datos, asegurando que solo usuarios autorizados puedan interactuar con ella.
• Validación de Datos: El agente está configurado para seguir prácticas de desarrollo guiado por pruebas (TDD), lo que ayuda a prevenir errores comunes de seguridad en el código.