Uso del Asistente de API para la corrección de errores

Puede utilizar el componente de error de validación de especificación del Asistente de API para analizar su especificación OpenAPI 3.0 y generar posibles correcciones de IA para cualquier error de validación. De este modo se acelera la entrega de sus API y se reducen los errores de validación.

El Asistente de API utiliza la dirección IBM watsonx Granite LLM models para ayudarle a mejorar la calidad de sus API y llevarlas más rápidamente a sus consumidores. Aproveche el Asistente de API para generar rápidamente correcciones de IA para sus definiciones de API.

Cómo utilizar el Asistente de API para generar correcciones de IA para sus errores de validación de OpenAPI 3.0

Utilice el Asistente de API al crear o editar una definición de API en el Gestor de API. El Asistente de API valida su API con la especificación OpenAPI 3.0, y sugiere correcciones de IA para los errores de validación. A continuación, puede elegir las correcciones que desea aplicar a su definición de API.

  1. Inicie sesión en IBM® API Connect Enterprise as a ServicePremium subscription .
  2. En Administrador de API, abra una OpenAPI 3.0 API que desee editar.
  3. En la pestaña Diseño, haga clic en el icono de la vista de fuentes (que es un pequeño cuadrado gris que contiene dos corchetes angulares que encierran una barra diagonal) para trabajar en la vista Fuente.
  4. Haga clic en el icono AI (que es un pequeño cuadrado gris con las letras AI y una flecha en negro) para abrir el panel del Asistente de API.
  5. Asegúrese de que está seleccionada la pestaña Errores de validación de especificaciones el icono de la pestaña de errores de validación de especificaciones (que es el contorno de una página con una pequeña marca de verificación).
  6. Haga clic en Validar para ejecutar su API a través de la especificación de validación OpenAPI.
  7. Si se detectan errores de validación en su API, y pueden ser corregidos por el Asistente de API, se muestran las correcciones sugeridas.
    Nota: No todos los errores de validación o advertencias tendrán una solución de AI que se pueda aplicar. Por ejemplo, no se devuelven las correcciones de IA para problemas relacionados con x-ibm.
  8. Para cada sugerencia, puede hacer clic en Corregir para incorporar la corrección a su API, o puede hacer clic en Ignorar para ignorar la corrección.

    Para aceptar rápidamente todas las sugerencias, haga clic en Aplicar correcciones.

  9. Haga clic en Guardar para guardar la definición de API actualizada.

Ejemplo: Mejora de la muestra Prueba de error API

En este ejemplo estamos utilizando un Prueba de error de API para mostrar el flujo a través de la validación de una API con la especificación OpenAPI, la revisión de las correcciones de IA sugeridas y la aplicación de dichas correcciones. Puede seguir los pasos con su propia API.

  1. Inicie sesión en API Connect Enterprise as a ServicePremium subscription.

  2. En Administrador de API, haga clic en el icono Revelar (que es un pequeño cuadrado negro con el contorno de un lápiz blanco) Desarrollar para abrir la página de desarrollo de API y, a continuación, asegúrese de que la pestaña APIs está seleccionada para poder ver sus API.
    Abrir la página Desarrollar

  3. Seleccione una API de Tipo OpenAPI 3.0 (REST), y haga clic en su Título para editarla.
    Editar una OpenAPI 3.0 API

  4. La página Diseño se abre en la vista Formulario. Haga clic en el icono de la vista de fuentes (que es un pequeño cuadrado gris que contiene dos corchetes angulares que encierran una barra diagonal) para trabajar en la vista Fuente.

    API Assistant es más fácil de usar cuando puede ver el código fuente de su API.

    Captura de pantalla de la página de diseño de la API en vista formulario, con un resaltado alrededor del icono de la vista fuente.

  5. Haga clic en el icono AI (que es un pequeño cuadrado gris con las letras AI y una flecha en negro) para abrir el panel del Asistente de API. Asegúrese de que está seleccionada la pestaña Errores de validación de especificaciones.
    Captura de pantalla que muestra el panel del Asistente de API, con la pestaña de errores de validación de especificaciones abierta.

  6. En la pestaña Errores de validación de especificaciones, puede hacer clic en el icono AI explicada (que es el contorno de un pequeño cuadrado negro, que contiene las letras AI) para obtener más información sobre cómo el Asistente de API utiliza la IA para resolver rápidamente los errores de sintaxis de OpenAPI.
    Captura de pantalla que muestra la ventana emergente de explicación de validación de la especificación AI.

    Vuelve a hacer clic en el icono AI explicada (que es el contorno de un pequeño cuadrado negro, que contiene las letras AI) para cerrar la ventana emergente.

  7. Ahora haga clic en Validar para validar su API con la especificación OpenAPI 3.0, y vea si se identifica alguna corrección de IA.

    Si se encuentran errores, y son corregibles por la IA, el Asistente de la API devuelve una lista de correcciones sugeridas.

    Captura de pantalla de las recomendaciones de la IA para los errores de validación de las especificaciones.

    Observe los siguientes cambios en la pantalla:

    • La pestaña Errores de validación de especificaciones muestra una lista de los errores de especificación que ha encontrado el Asistente de API. Al principio del panel se muestra el número total de errores encontrados.
    • Mientras el panel Asistente de API está abierto, el código fuente de la API está en modo de sólo lectura para evitar actualizaciones accidentales. Al cerrar el panel, el código vuelve a ser editable.
    • Si existe una corrección de IA sugerida para el error, la corrección se muestra en la pestaña Errores de validación de especificaciones con las opciones Ignorar y Corregir. La solución sugerida también aparece en el código fuente, justo debajo del error original.
    • Si el error no tiene una solución AI, el error se muestra con un icono de error de validación el icono de error de validación es un pequeño punto rojo que contiene una barra invertida blanca.
  8. Cuando esté listo para aceptar o rechazar las correcciones sugeridas, dispondrá de las siguientes opciones:
    • Para aceptar rápidamente todas las correcciones sugeridas, haga clic en Aplicar correcciones.
    • Para aceptar o rechazar correcciones individuales, haga clic en Corregir o Ignorar en cada sugerencia.
    • Para volver a ejecutar la validación, haga clic en Regenerar todos los iconos para ver los últimos errores de especificación y correcciones de IA.

    A medida que realice las correcciones sugeridas, tenga en cuenta el siguiente comportamiento:

    • Cualquier corrección que aplique se añade a la definición de API, pero la definición en sí no se guarda hasta que haga clic en Guardar en el encabezado de la página de API.
    • Antes de guardar, puede seguir editando la API y volver a ejecutar la validación para regenerar las correcciones sugeridas.
    • Cuando haga clic en Guardar, se guardarán sus propios cambios y todas las correcciones aplicadas; sin embargo, se perderán las sugerencias que no haya aplicado.
    • Si sale de la página Diseño de API antes de aplicar una corrección, ésta se perderá.
  9. Para cerrar el panel Asistente de API, haga clic en el icono de cierre del panel del asistente API.

  10. Si desea volver a la vista Formulario, haga clic en el icono de la vista de formulario.

    En la API de ejemplo, puede ver que se han aplicado las correcciones de IA sugeridas y que el estado de la especificación es ahora verde.

    Captura de pantalla de la API de ejemplo con todos los errores corregidos.

  11. Recuerde hacer clic en Guardar para guardar su definición de API actualizada.