Utilización de API Agent

Puede utilizar API Agent para publicar y probar API de extremo a extremo. A continuación se incluyen secciones con información detallada sobre lo que puede esperar al utilizar el complemento API Agent y un escenario de flujo de extremo a extremo de ejemplo, que puede recorrer para comprender cómo funciona el agente y las capacidades disponibles en el mismo.

Los administradores pueden asignar las funciones apropiadas para habilitar API Agent para desarrolladores específicos dentro de su organización. Esta habilitación selectiva garantiza que la herramienta se utilice eficazmente en el contexto adecuado. Después de que el administrador configure las fuentes, los desarrolladores pueden instalar el complemento Visual Studio Code y empezar a integrarlo en su espacio de trabajo. Para más información, consulte la sección de roles de usuario del Agente API.

Mejores prácticas

La extensión API Agent es una herramienta que se utiliza en Visual Studio Code para ayudar en la gestión de la API. Para que funcione correctamente, es imprescindible que la ventana extensible esté a toda altura y tenga al menos 1/3 de la anchura de la ventana.
Comprender las indicaciones de la documentación
Cuando vea un comando en la documentación, es esencial que entienda cómo utilizarlo correctamente.

  1. Si un comando contiene un marcador de posición, como [apiName], debe sustituirlo por su propio texto. Por ejemplo:

    • Mandato: Run test cases for [apiName]:[version]
    • Sustitución: Run test cases for bookshop-api-3:1.0
    Nota: Asegúrese de sustituir [apiName] por el nombre real de su API para ejecutar el comando.

  2. Para rellenar el marcador de posición, como [@file]:

    • El documento puede tener la siguiente indicación: remediate api [@file] using spectral-owasp ruleset. Sustitúyalo por remediate api @bookstore.yaml using spectral-owasp ruleset.

    Para sustituir [@file], debe activar el símbolo @ para acceder a los archivos de su espacio de trabajo Visual Studio Code. A continuación, seleccione el archivo que desea cargar en el agente.

Para iniciar una nueva sesión
Para mantener la sesión activa, es necesario borrar cualquier dato temporal o residual que pueda estar causando problemas y, a continuación, actualizar el sistema para asegurarse de que se encuentra en un estado actualizado.
Para mantener la sesión activa y actualizarla, siga estos pasos:
  1. Introduzca CMD + MAYÚS + P para abrir la paleta de comandos Visual Studio Code.
  2. En la línea de comandos, introduzca Developer: Reload window.
  3. En la línea de comandos, introduzca API Agent: Logout.
    Nota: Este comando elimina la sesión de inicio de sesión, pero es necesario volver a realizar el proceso de autenticación. Sin embargo, la información de inicio de sesión ( pOrg, login URL, y más) sigue almacenada en caché
  4. Para eliminar toda la información de inicio de sesión almacenada en caché después de cerrar la sesión, en la línea de comandos, introduzca API Agent: Clear session from workspace state and reload.
    Nota: Cuando se elimina o desactiva un complemento en Visual Studio Code, la información de inicio de sesión almacenada en caché persiste. Esto significa que cuando vuelva a descargar el plug-in, el campo URL se rellenará con el último URL utilizado.
Proceso de depuración
A efectos de depuración, hay dos áreas que explorar en la paleta de comandos Visual Studio Code.
Para ver el lado Visual Studio Code de la extensión, complete los siguientes pasos:
  1. Introduzca CMD + MAYÚS + P para abrir la paleta de comandos Visual Studio Code.
  2. En la línea de comandos, introduzca Show Output Channels, y seleccione el comando de la lista.
  3. En la lista de canales de salida, seleccione API Agent Debug Logs.
  4. Visual Studio Code muestra la siguiente información:
    • Datos de inicio de sesión.
    • Reinicialización de la extensión tras cambiar de pestaña.
Para ver el lado webview del chat, siga los siguientes pasos:
  1. Introduzca CMD + MAYÚS + P para abrir la paleta de comandos Visual Studio Code.
  2. En la línea de comandos, introduzca Developer: Open Webview Developer Tools, y seleccione el comando de la lista.
  3. Puede consultar las herramientas de desarrollo de la vista web, donde podrá acceder a la siguiente información:
    • Pestaña Consola: permite ver los registros y la salida de la consola
    • Pestaña Red: inspeccionar las llamadas REST que se realizan
Adjuntar y descargar archivos
Para adjuntar y descargar un archivo, siga estos pasos:
  1. Para adjuntar un archivo, debe activar el menú de archivos escribiendo @ y seleccionando a continuación el archivo.
    Nota: El tamaño máximo del archivo es de 1 GB, y el nombre del archivo no debe contener espacios ni caracteres especiales.
  2. Si ha copiado y pegado un comando como validate api @testapi.yaml, vuelva al comando base validate api y vuelva a escribir @ para activar el menú de archivo.
  3. Seleccione un archivo en el menú de archivos que aparece tras escribir @.
  4. Cuando un botón de acción siguiente incluye una referencia a un archivo, por ejemplo, remediate api [@file] using spectral-owasp ruleset, debe sustituir [@file] por un nuevo archivo adjunto activando el menú de archivos con el símbolo @ .
  5. Para borrar el nombre del archivo en la línea de comandos, borre el comando y vuelva a introducir validate api.
API Agent problemas de recarga y cierre de sesión
  • Si no utilizas el chat durante un tiempo, el token utilizado con API Connect caduca durante este tiempo y si continúas manteniendo una conversación, muestra un Error: Unauthorized y te desconecta automáticamente. Tienes que volver a realizar el proceso de inicio de sesión.
  • Para borrar correctamente los recursos, debe utilizar la opción de cierre de sesión dentro del complemento en lugar de la opción de cierre de sesión gestionada por Visual Studio Code.
    Importante: El plug-in API Agent ha cambiado su nombre de API Assistant. Si tienes la versión antigua, elimínala antes de descargar la nueva.
Uso de una pila diferente o inicio de sesión con un usuario diferente en la misma pila
Después de cerrar la sesión de una pila o usuario, borre la sesión del estado del espacio de trabajo, el API Agent podría utilizar información obsoleta al cambiar a otro, dando lugar a problemas de persistencia.
Para resolver este problema, complete los pasos siguientes:
  1. Cerrar la sesión de la pila o usuario actual.
  2. En la paleta de comandos, ejecute el siguiente comando:
    API Agent: Clear session from workspace state
  3. Vuelva a cargar la página.
  4. Inicia sesión con la nueva pila o usuario.