Crear un entorno y una variable de entorno

Escenario

Una API se puede llamar en diferentes entornos, como entornos de producción, pruebas y desarrollo. RELEASE es el entorno predeterminado proporcionado por API Gateway. Puede definir variables de entorno para permitir que se llame a una API en diferentes entornos.

Las variables de entorno son manejables y específicas para entornos. Puede crear variables en diferentes entornos para llamar a diferentes servicios de backend utilizando la misma API.

Para las variables que defina durante la creación de la API, debe crear las variables y los valores correspondientes. Por ejemplo, la variable Path se define para una API, y dos variables con el mismo nombre se crean y asignan los valores //Stage/test y /Stage/AA en los entornos 1 y 2, respectivamente. Si la API se publica y se llama en el entorno 1, se utiliza la ruta /Stage/test. Si la API se publica y se llama en el entorno 2, se utiliza la ruta /Stage/AA.

Figura 1 Uso de variables de entorno

Puede crear un máximo de 50 variables para un grupo de API en cada entorno.

Prerrequisitos

Ha creado un grupo de API.

Creación de un entorno

1. Inicie sesión en la consola de gestión.
2. Haga clic en en la esquina superior izquierda y seleccione una región.
3. Haz clic en en la esquina superior izquierda y elige API Gateway.
4. Elija un tipo de puerta de enlace en el panel de navegación.
   • Shared Gateway: puede crear y gestionar API de inmediato. Se le facturará en función del número de llamadas API.
   • Dedicated Gateways: puede crear y gestionar API después de comprar una puerta de enlace. Se le facturará en función de la duración del uso del gateway.

5. En el panel de navegación, elija API Publishing > Environments.
6. Haga clic en Create Environment, y defina los parámetros enumerados en Tabla 1.
   Figura 2 Creación de un entorno
   

   Tabla 1 Información del entorno

   Parámetro	Descripción
   Name	Nombre del entorno.
   Description	Descripción del entorno.

7. Haga clic en OK.

   Después de crear el entorno, se muestra en la lista de entornos.

Acceso a un entorno

Puedes llamar a una API en el entorno RELEASE usando una RESTful API. Para acceder a la API en otros entornos, agregue el encabezado X-Stage a la solicitud para especificar un nombre de entorno. Por ejemplo, agregue X-Stage:DEVELOP al encabezado de solicitud para acceder a una API en el entorno DEVELOP.

API Gateway no admite la depuración de API mediante variables de entorno.

Creación de una variable de entorno

1. Inicie sesión en la consola de gestión.
2. Haga clic en en la esquina superior izquierda y seleccione una región.
3. Haz clic en en la esquina superior izquierda y elige API Gateway.
4. Elija un tipo de puerta de enlace en el panel de navegación.
   • Shared Gateway: puede crear y gestionar API de inmediato. Se le facturará en función del número de llamadas API.
   • Dedicated Gateways: puede crear y gestionar API después de comprar una puerta de enlace. Se le facturará en función de la duración del uso del gateway.

5. En el panel de navegación, elija API Publishing > API Groups.
6. Cree una variable. Puede utilizar uno de los métodos siguientes:
   • Haga clic en el nombre del grupo de API de destino y haga clic en la pestaña Variables de la página de detalles del grupo de API que se muestra.
   • En la columna Operation del grupo API de destino, elija More > Manage Variable.

7. Seleccione un entorno en la lista desplegable Environment y haga clic en Create Variable.
8. Establezca los parámetros enumerados en Tabla 2.
   Figura 3 Creación de una variable de entorno
   

   Tabla 2 Parámetros para crear una variable de entorno

   Parámetro	Descripción
   Name	Nombre de la variable que desea crear. Asegúrese de que el nombre es el mismo que el nombre de la variable definida para la API.
   Value	La ruta de acceso que se va a utilizar en el entorno seleccionado.

9. Haga clic en OK.
   

   Si no se necesita una variable, haga clic en Delete en la fila que contiene la variable para eliminarla.

   Los nombres y valores de las variables de entorno se mostrarán en texto sin formato en las solicitudes de API. No incluya información confidencial en los nombres y valores de las variables.

Operaciones de seguimiento

Después de crear un entorno y una variable, publique las API en el entorno para que puedan ser llamadas por los llamantes de la API.

Creación de una variable de entorno y entorno mediante llamada a una API

También puede crear un entorno y una variable de entorno llamando a una API proporcionada por API Gateway. Para obtener más información, consulte las siguientes referencias:

Creación de un entorno

Creación de una variable de entorno

Preguntas frecuentes sobre las variables de entorno

¿Puedo invocar diferentes servicios de backend publicando una API en diferentes entornos?