Configura la administració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 Apigee API Management en Cloud Code para VS Code. Consulta Descripción general del desarrollo local con Apigee para conocer las funciones del entorno de desarrollo local.

El proceso de configuración requiere que se completen ambas secciones de esta guía:

Según tus casos de uso, también completa Configura el desarrollo de proxies de API para el desarrollo local de Apigee.

Antes de comenzar

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

  1. Un proyecto Google Cloud en el que acceder en tu entorno de desarrollo local. El proyecto debe aprovisionarse para que Apigee cree un lugar de trabajo local de Apigee en el que puedas desarrollar y probar proxies de API.
  2. (Recomendado) Concentrador de APIs aprovisionado en tu proyecto. Se requiere el centro de APIs para crear un servidor de simulación remoto para probar las especificaciones de la API.

    Si no quieres agregar el concentrador de APIs a tu proyecto, puedes asociarlo con otro proyecto que tenga habilitado el concentrador de APIs. Consulta Cómo conectar un proyecto de entorno de ejecución a un centro de APIs para obtener información sobre cómo conectar 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 planeas realizar.
  4. Debes tener conocimientos sobre VS Code, cómo administrarlo y cómo realizar acciones comunes, como acceder a la configuración e instalar extensiones. Consulta la documentación de VS Code.

Instala VS Code y la extensión de Cloud Code

En esta sección, se proporcionan las instrucciones para instalar VS Code y la extensión de 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 de Cloud Code, haz lo siguiente:

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

Roles obligatorios para usar el concentrador de API de Apigee con el desarrollo local de Apigee

Necesitarás los roles que se indican a continuación para realizar los pasos de diseño y prueba de la API con el centro de APIs de Apigee:

Tarea Roles requeridos
Visualiza y edita las APIs del centro de APIs Editor o administrador del concentrador de la API de Cloud
Publica APIs en el centro de APIs Editor o administrador del concentrador de la API de Cloud
Configura y administra un servidor de simulación remoto para probar APIs Administrador de Artifact Registry
Cuenta de servicio de Cloud Build
Administrador de Cloud Run
Administrador de Service Usage

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

También debes tener instalada la CLI de gcloud.

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

Completa los pasos de esta sección si deseas usar tu entorno de desarrollo local para el desarrollo y las pruebas de proxies de API de Apigee. También completa estos pasos para poder crear un proxy de API a partir de una especificación de OpenAPI.

  1. Crea un lugar de trabajo de Apigee.
  2. Instala el emulador de Apigee.
  3. Agrega un contenedor para implementar en el emulador de Apigee.

¿Qué sigue?

Después de completar los pasos de instalación y configuración, comienza a usar Cloud Code: