Creación de APIs asistida por IA (Beta)

La opción Create API with AI (beta) permite crear APIs REST de forma rápida y sencilla con la ayuda de inteligencia artificial. Es una funcionalidad ideal para desarrolladores que desean ahorrar tiempo y esfuerzo en la creación de APIs y optimizar su flujo de trabajo.

En esta página encontrará todo sobre el funcionamiento de esta opción y cómo utilizarla.

Creando una nueva API con ayuda de IA

Para crear una nueva API con la ayuda de inteligencia artificial, haga clic en el botón + Create API, ubicado en la esquina superior derecha de la pantalla API Catalog y seleccione la opción Create API with AI (beta).

Para que esta funcionalidad esté disponible en su entorno, solicite su liberación al equipo de producto a través del canal de soporte.

La siguiente pantalla iniciará un proceso compuesto por cinco etapas para la creación de la API:

  1. Context

  2. Prompt

  3. Journey

  4. Endpoints

  5. Contract

Puede avanzar por las etapas mediante el botón Next o regresar a etapas anteriores haciendo clic en el botón Back, ambos ubicados en la esquina inferior derecha de las pantallas (cuando corresponda). Si hay algún campo obligatorio no completado en la pantalla, el botón Next estará deshabilitado.

A continuación, consulte información sobre cada una de las etapas.

Context

Se trata de una etapa opcional, en la que puede proporcionar información sobre el contexto de la API que desea crear. Esto se realiza mediante el envío de enlaces y archivos que servirán como fuentes de conocimiento para el modelo de IA, ayudándole a comprender mejor sus necesidades. Puede agregar, por ejemplo, documentos y enlaces que contengan definiciones de procesos, nomenclaturas, estructuras de datos y reglas de negocio relevantes. Es posible agregar múltiples enlaces y archivos.

Los enlaces corresponden a fuentes externas de conocimiento (URLs de páginas web). Para agregar un nuevo enlace, siga estos pasos:

  1. Haga clic en el botón Add Link, ubicado en la esquina superior derecha de la pantalla.

  2. En la ventana modal que se abrirá, introduzca la URL deseada en el campo URL.

  3. Haga clic en el botón Save para agregar el enlace.

Los enlaces agregados se muestran como tarjetas en la sección Links de la pantalla, y cada tarjeta contiene:

  • parte de la URL ingresada;

  • fecha en que se agregó el enlace (Created at);

  • acciones disponibles:

    • ícono de copia copiar el enlace;

    • ícono de lápiz editarlo;

    • ícono de papelera eliminarlo.

Los archivos corresponden a documentos que puede enviar para contextualizar el modelo de IA. Los formatos aceptados son PDF, TXT, DOCX y SQL, con un tamaño máximo de 5MB por archivo. Para agregar un nuevo archivo, siga estos pasos:

  1. Haga clic en el botón Add File, ubicado en la esquina superior derecha de la pantalla.

  2. En la ventana modal que se abrirá, asigne un nombre a este contexto escribiéndolo en el campo Context Name y haga clic en el botón Select File para seleccionar el archivo deseado en tu máquina.

  3. Haga clic en el botón Save para enviar el archivo.

Los archivos agregados se muestran como tarjetas en la sección Files de la pantalla, y cada tarjeta contiene:

  • nombre dado al contexto;

  • fecha en la que se agregó el archivo (Created at);

  • tipo de archivo (File type);

  • acciones disponibles:

    • ícono de lápiz editarlo;

    • ícono de papelera eliminarlo.

Prompt

La segunda etapa del flujo de creación de la API, Prompt, es obligatoria y permite proporcionar una descripción detallada de los requisitos de negocio de la API a generar. El contenido ingresado será interpretado por la IA para generar la estructura de la API, incluyendo los endpoints, las jornadas y el contrato.

Introduzca el texto correspondiente a la descripción en el campo presente en la pantalla. El texto ingresado debe tener entre 40 y 2000 caracteres. Es importante ser lo más claro y específico posible en la descripción, para que la IA pueda comprender sus necesidades y generar una API adecuada a ellas. Puede incluir detalles como:

  • funcionalidades deseadas;

  • escenarios de uso;

  • tipos de datos que la API debe manejar;

  • reglas de negocio específicas;

  • integraciones con otros sistemas;

  • requisitos de seguridad;

  • cualquier otra información relevante que ayude al modelo de IA a comprender tus necesidades.

Journey

En la etapa Journey, puede visualizar las jornadas de negocio de la API generadas por la IA con base en la información proporcionada en las dos etapas anteriores. Cada jornada representa un flujo funcional de la API (un recurso) y su nombre y descripción se utilizarán como base para la definición de los endpoints en la siguiente etapa.

En esta etapa, puede:

  • visualizar el nombre de la API (campo API Name:);

  • editar, eliminar o agregar jornadas según sea necesario;

  • verificar la relevancia de los archivos y enlaces proporcionados en la etapa Context en relación con el prompt ingresado.

Jornadas

Las jornadas identificadas por la IA se muestran en una lista en la sección Journeys de la pantalla. Cada elemento representa una jornada y contiene:

  • nombre de la jornada;

  • descripción de la jornada;

  • acciones disponibles:

    • ícono de lápiz permite cambiar el nombre o la descripción de la jornada;

    • ícono de papelera elimina la jornada.

Además, está el botón Add Journey, ubicado sobre la lista de jornadas a la derecha, que permite agregar manualmente una nueva jornada a la lista, para contemplar flujos no detectados automáticamente por la IA.

Relevance Score

Debajo de la sección Journeys, se encuentra la sección Relevance Score, que muestra el nivel de relevancia de los archivos y enlaces proporcionados como contexto en la etapa Context en relación con el prompt ingresado.

Cada contexto está representado por una tarjeta que contiene:

  • nombre del contexto;

  • puntuación de relevancia (Score).

Esta información es útil para evaluar qué contextos están siendo más influyentes en la generación de las jornadas. Puntuaciones más altas indican que el contenido del contexto está más alineado con la descripción del prompt, lo que puede afectar directamente la calidad de las jornadas y los endpoints generados.

Los contextos irrelevantes o genéricos pueden ser descartados para evitar ruido en la generación de las jornadas y endpoints.

Endpoints

En la etapa Endpoints, puede visualizar los endpoints generados por la IA con base en las jornadas creadas en la etapa anterior. Para cada jornada, se generan uno o más endpoints. Cada endpoint representa una operación específica que la API puede realizar y está compuesto por un método HTTP, una ruta (path) y la descripción correspondiente.

Cada jornada se muestra en la pantalla en una tarjeta que contiene:

  • Nombre de la jornada: identifica la jornada;

  • Descripción: breve explicación sobre el objetivo de la jornada y sus funcionalidades;

  • Tabla de endpoints, con las siguientes columnas:

    • METHOD: método HTTP utilizado (GET, POST, PATCH, etc.).

    • PATH: ruta de la API que representa la acción.

    • SUMMARY: descripción del propósito del endpoint.

Debajo de la tabla de endpoints, también hay botones de acción, que permiten:

  • ícono de lápiz modificar o eliminar endpoints específicos de la jornada, así como agregar nuevos endpoints a ella.

  • ícono de papelera eliminar la jornada y todos sus endpoints.

Contract

En la etapa Contract, puede visualizar y descargar el contrato de la API generado por la IA con base en la información proporcionada en las etapas anteriores, así como crear la API directamente en API Management.

En la pantalla se muestran los siguientes metadatos del contrato:

  • Contract: Nombre de la API.

  • Version: Versión del contrato generado.

  • OpenAPI: Versión del estándar OpenAPI utilizada en la generación del contrato.

  • Contract Description: Descripción del contrato.

Mediante los botones ubicados en la esquina inferior derecha, puede realizar las siguientes acciones:

  • ícono de papelera eliminar el contrato.

  • ícono de código visualizar el contrato en formato bruto (YAML).

  • ícono de swagger visualizar el contrato como documentación interactiva.

  • ícono de flecha hacia abajo descargar el archivo del contrato.

  • Generate API: crear la API en API Management con base en el contrato generado.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]