Instructivo: Usa Gemini Code Assist para diseñar, desarrollar y probar APIs en Apigee y Cloud Code

Esta página se aplica a Apigee y Apigee Hybrid.

Descripción general

En este instructivo, se explica el proceso de usar Gemini Code Assist en Cloud Code para diseñar una API y crear un proxy de API de Apigee a partir de una especificación de API generada. En este instructivo, usarás una instrucción de lenguaje natural para diseñar y crear una API que administre la publicación de blogs relacionada con deportes para un sitio web.

Antes de comenzar

Para completar este instructivo, necesitarás lo siguiente:

  • La API de Cloud AI Companion configurada para tu proyecto de Apigee o ser administrador de la organización de Apigee a fin de que puedas agregarla. Para ver los pasos de configuración de Gemini Code Assist, consulta Cómo usar Gemini Code Assist.
  • Para ser administrador de la API de Apigee en tu proyecto de Apigee.
  • A fin de configurar el desarrollo local para tu proyecto de Apigee en Cloud Code, si aún no lo hiciste. Consulta Configura la administración de la API de Apigee en Cloud Code para VS Code.
  • Conocimientos de las especificaciones de OpenAPI para que puedas revisar las especificaciones generadas.
  • (Opcional) Configuración del concentrador de APIs para este proyecto. Aunque no es estrictamente obligatorio para usar las funciones de Gemini Code Assist que se describen aquí, no podrás realizar todos los pasos sin el concentrador de APIs.

Paso 1: Carga Apigee en Cloud Code

Abre VS Code y haz clic en el ícono de Cloud Code. Deberías ver tu proyecto de Apigee y cualquier API.

Menú izquierdo de Gemini Code Assist de Cloud Code

Paso 2: Abre la pestaña Crear una especificación de API y, luego, ingresa una instrucción

Haz clic en la varita mágica en la fila Apigee para abrir la pestaña de creación de especificaciones.

Varita mágica de creación de especificaciones de Gemini Code Assist de Cloud Code

En la pestaña, se muestran plantillas que puedes usar para iniciar la solicitud de la API. Debajo de ellos, hay un campo de entrada de instrucción de formato libre. Haz clic en API para el contenido de blogs. Una instrucción de lenguaje natural que describe esta API se propaga en el campo de entrada de la instrucción.

Formulario de especificaciones de Gemini Code Assist para Cloud Code

Paso 3: Crea y consulta las especificaciones

Haz clic en Crear para generar una especificación de API a partir de esta instrucción. Espera mientras se genera la especificación; el panel Resultado muestra los pasos a medida que se crea la especificación.

Una vez creados, desplázate hacia abajo para ver la descripción, los extremos y los esquemas de la especificación. Para ver el código de especificación de OpenAPI, haz clic en Ver código.

Extremos de especificaciones de Gemini Code Assist para Cloud Code

Paso 4: Modifica la instrucción y vuelve a crear la especificación

Vuelve a la instrucción y agrega el tipo de deporte como parte del objeto de datos.

Instrucción editada de Gemini Code Assist de Cloud Code

Haz clic en Crear de nuevo para volver a generar la especificación. Verás el tipo de deporte en la especificación actualizada.

Ten en cuenta que también puedes volver al mensaje anterior si haces clic en el historial de mensajes en la parte superior de la casilla de entrada del mensaje.

Paso 5: Edita la especificación

Para cambiar la especificación, haz clic en Ver código y escribe tus actualizaciones directamente en la especificación. Para este ejemplo, cambia la descripción a “API de administración de contenido de entradas de blog de deportes”.

Código editado de Gemini Code Assist de Cloud Code

Paso 6: Prueba la API con un servidor de simulación

Prueba la API con el servidor de muestra local, que emula las respuestas de la API. En el menú desplegable Servidores, selecciona la opción con Servidor de desarrollo local en el nombre. Una vez seleccionada, abre la ruta POST y haz clic en Probar.

Modifica los valores "autor", "contenido" y "título" en el cuerpo de la solicitud para usar tus propios valores:

{
    "author": "My name",
    "categories": [
      "string"
    ],
    "content": "This is my blog post",
    "featuredImageUrl": "string",
    "publishedDate": "string",
    "tags": [
      "string"
    ],
    "title": "Baseball in the age of AI"
  }

Haz clic en Ejecutar para ver una respuesta ficticia de la API en la sección Respuestas.

Paso 7: Guarda tu API en el concentrador de APIs

(Opcional) Una vez que tu API se haya revisado y finalizado, haz que esté disponible para los desarrolladores mediante el registro en el centro de API:

  1. Haz clic en Register to API Hub.
  2. Sigue las indicaciones para registrar la API. Consulta Registra API para obtener información sobre cómo registrarte con el concentrador de API y la información que debes proporcionar.

Haz clic en Guardar para guardar la API nueva con el nombre que elijas.

Paso 8: Crea un paquete de proxy de API a partir de esta especificación

Para crear un paquete de proxies de la API de Apigee a partir de esta especificación, haz clic en Crear paquete de proxies de API en el menú Más. Después de la creación, deberías ver el nuevo proxy en apiproxies en el menú de la izquierda. Consulta Desarrolla proxies de API para obtener información sobre cómo trabajar con proxies de API en Cloud Code.
Crea un paquete de proxies de API de Cloud Code Gemini Code Assist

Próximos pasos