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 proporcionan instrucciones para crear un entorno de desarrollo local de gestión de APIs de Apigee en Cloud Code para VS Code. 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, también puedes completar la sección Configurar el desarrollo de proxies de API para el desarrollo local de Apigee.

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. El proyecto debe aprovisionarse para que Apigee cree un espacio de trabajo local de Apigee en el que puedas desarrollar y probar proxies de API.
  2. (Recomendado) Centro de APIs aprovisionado en tu proyecto. El Centro de APIs es necesario para crear un servidor simulado remoto para probar las especificaciones de la API.

    Si no quieres añadir el centro de APIs a tu proyecto, puedes asociar el proyecto con otro 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 el centro de APIs con el desarrollo local de Apigee para las acciones que quieras realizar.
  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.

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.

Roles necesarios para usar el centro de APIs de Apigee con el desarrollo local de 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 el centro de APIs de Apigee:

Tarea Rol(es) obligatorio(s)
Ver y editar APIs de API Hub 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: