Configurar la gestión de APIs de Apigee en Cloud Code para VS Code

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

Consulta la documentación de Apigee Edge.

En esta página se explica cómo crear un entorno de desarrollo local de gestión de APIs de Apigee en Cloud Code para VS Code, que admite Gemini Code Assist para el diseño y el desarrollo de especificaciones de OpenAPI. Consulta la información general sobre el desarrollo local con Apigee para ver las funciones del entorno de desarrollo local.

Para completar el proceso de configuración, debes seguir las instrucciones de ambas secciones de esta guía:

En función de tus casos prácticos, completa una o ambas de estas secciones:

Antes de empezar

Para configurar y usar Apigee en VS Code, necesitas lo siguiente:

  1. Un Google Cloud proyecto para iniciar sesión en tu entorno de desarrollo local. No es necesario aprovisionar el proyecto para Apigee para usar Gemini Code Assist y desarrollar especificaciones de APIs, pero sí para crear un espacio de trabajo local de Apigee donde puedas desarrollar y probar proxies de APIs. También es necesario aprovisionar Apigee para ver las APIs del hub de APIs de Apigee en la sección Apigee de Cloud Code.
  2. (Recomendado) Centro de APIs aprovisionado en tu proyecto. El hub de APIs es necesario para estas funciones: Si no quieres añadir el centro de APIs a tu proyecto, puedes asociar el proyecto con otro proyecto que tenga habilitado el centro de APIs. Consulta Asociar un proyecto de tiempo de ejecución a un centro de APIs para obtener información sobre cómo asociar un proyecto a un centro de APIs.
  3. Los roles necesarios para usar Gemini Code Assist en Apigee para las acciones que quieras realizar. Para configurar Gemini Code Assist, debes tener el rol Administrador de uso de servicios en tu cuenta de usuario del proyecto.
  4. Familiaridad con VS Code, cómo gestionarlo y cómo realizar acciones habituales, como acceder a la configuración e instalar extensiones. Consulta la documentación de VS Code.

Instalar VS Code y la extensión Cloud Code

En esta sección se proporcionan las instrucciones para instalar VS Code y la extensión Cloud Code en VS Code. Este es el primer paso para configurar el desarrollo local de Apigee y es necesario para usar cualquiera de las funciones de desarrollo local de Apigee, incluido Gemini Code Assist.

Para instalar VS Code y la extensión Cloud Code, sigue estos pasos:

  1. Descarga e instala Visual Studio Code (VS Code) en tu máquina local, si aún no lo has hecho.
  2. Instala la extensión Cloud Code, tal como se describe en Instalar la extensión Cloud Code. Si tienes previsto gestionar proxies de APIs en tu entorno local, instala Docker como parte del proceso.
  3. (Recomendado) Habilita las actualizaciones automáticas de la extensión Cloud Code. En Configuración, busca Extensiones: actualización automática y habilítala para todas las extensiones o para la extensión Cloud Code de forma individual.
  4. Reinicia VS Code.

Configurar Gemini Code Assist en Apigee

Sigue estos pasos para configurar Gemini Code Assist para Apigee en tu entorno de desarrollo local. Consulta los roles necesarios para usar Gemini Code Assist en Apigee.

  1. Si aún no lo has hecho, asegúrate de completar los pasos que se indican en el artículo Instalar VS Code y la extensión Cloud Code.
  2. Instala la extensión Gemini Code Assist en VS Code.
  3. (Recomendado) Habilita las actualizaciones automáticas de la extensión Gemini Code Assist. En Ajustes, busca Extensiones: actualización automática y habilítala para todas las extensiones o para la extensión Gemini Code Assist de forma individual.
  4. Si aún no lo has hecho, instala gcloud CLI.
  5. Habilita la API Gemini for Google Cloud en el proyecto. Para realizar este paso, debes tener el rol Administrador de uso de servicios.
    gcloud services enable cloudaicompanion.googleapis.com --project=YOUR_PROJECT
  6. En VS Code, inicia sesión en tu Google Cloud proyecto en ambas extensiones: Gemini Code Assist y Cloud Code. Puedes hacerlo con cualquiera de estos métodos:
    • Añade manualmente el proyecto en tu archivo settings.json:
      {
        "cloudcode.apigee.gemini.options": {
            "cloudcode.project": "YOUR_PROJECT",
            "geminicodeassist.project": "YOUR_PROJECT"
          ...
          }
        }
    • Selecciona el proyecto cuando se te pida:

      Si abres el chat de Gemini Code Assist y no has iniciado sesión en un proyecto con Gemini habilitado, verás un mensaje que te indica que debes iniciar sesión. Selecciona seleccionar un Google Cloud proyecto para añadirlo.
      Falta el proyecto de Gemini Code Assist para Gemini Code Assist Chat

      Para seleccionar un proyecto para Google Cloud en la sección Apigee de Cloud Code, expande la sección API hub y haz clic en Cloud Code - No Project selected (Cloud Code: ningún proyecto seleccionado):
      Google Cloud no project

      También puedes hacer clic en el nombre del proyecto en la barra de estado de Cloud Code y seleccionar el nuevo proyecto: Barra de estado de Cloud Code que muestra el proyecto de Apigee
  7. Añade a tu cuenta de usuario los roles necesarios para usar Gemini Code Assist en Apigee.
  8. Si quieres crear un paquete de proxy de API a partir de una especificación de OpenAPI y gestionarlo en tu entorno de desarrollo local, sigue los pasos que se indican en Configurar el entorno de desarrollo local para desarrollar proxies de API.

Roles necesarios para usar Gemini Code Assist en Apigee

Necesitarás los roles que se indican a continuación para llevar a cabo los pasos de diseño y prueba de APIs con Gemini Code Assist:

Tarea Rol(es) obligatorio(s)
Diseñar APIs con Gemini Code Assist Usuario de Gemini para Google Cloud
Consumidor de uso del servicio

Consulta Conceder roles de IAM en un proyecto de Google Cloud para Gemini Code Assist.
Utiliza el contexto de empresa de tus APIs en el centro de APIs cuando diseñes APIs Visor de Cloud API Hub
Editar las APIs del centro de APIs Editor o administrador de Cloud API Hub
Publicar APIs en el Centro de APIs Editor o administrador de Cloud API Hub
Configurar y gestionar un servidor simulado remoto para probar APIs Administrador de Artifact Registry
Cuenta de servicio de Cloud Build
Administrador de Cloud Run
Administrador de uso de servicios

Consulta la referencia de roles básicos y predefinidos de IAM.

También debes tener instalada la CLI de gcloud.

Configurar el desarrollo de proxies de API para el desarrollo local de Apigee

Sigue los pasos de esta sección si quieres usar tu entorno de desarrollo local para desarrollar y probar proxies de API de Apigee. También debes completar estos pasos para poder crear un proxy de API a partir de una especificación de OpenAPI.

  1. Crea un espacio de trabajo de Apigee.
  2. Instala el emulador de Apigee.
  3. Añade un contenedor para desplegarlo en el emulador de Apigee.

Siguientes pasos

Una vez que hayas completado los pasos de instalación y configuración, empieza a usar Cloud Code: