Thanks for your feedback!
EDIT
Variables de entorno
Las variables de entorno (environment variables) son variables con valores únicos dentro de un entorno específico. Se utilizan como configuración adicional para cada entorno, lo que permite personalizar las peticiones para cambiar fácilmente entre diferentes contextos. No son obligatorias, pero facilitan el proceso de diseño y gobierno de APIs.
El API Manager permite crear variables de entorno que se pueden utilizar en diversos puntos de nuestra plataforma:
-
En el Target o Timeout de la API Destination;
-
Al habilitar un Connector; o
-
En varios Interceptors, como se muestra en la tabla a continuación.
Lista de interceptors que permiten el uso de variables de entorno:
Time allowed |
XML Threat protection |
Service mashup |
Query param |
|
Imagine que varias APIs desplegadas en un entorno comparten el mismo target destination y, en algún momento, ese destino cambia. Sin variables de entorno, sería necesario cambiar el target destination en cada API. Sin embargo, si el destino está definido como una variable de entorno, solo necesita cambiar el valor de esa variable en el entorno específico, y todas las APIs se actualizarán automáticamente. |
Registrando variables de entorno
Para registrar variables de entorno, debe crear un mapa de variables o importar uno existente de otro entorno.
Para agregar un mapa:
-
Haga clic en el botón ADD MAP;
-
En la pantalla que se abre, defina el nombre del mapa.
Ahora puede crear variables de entorno como pares clave-valor donde ambos son cadenas de caracteres.
El campo Type permite cambiar el tipo de variable a las siguientes opciones:
-
DEFAULT: tipo predeterminado para todas las variables. No cambia nada en su comportamiento.
-
SECURED: valor encriptado, descifrado solo por el flujo de un connector, garantizando mayor seguridad en el almacenamiento de credenciales, ya que el valor no es recuperable de ninguna otra forma.
También puede agregar un certificado correspondiente a la comunicación entre el gateway y el backend. Cuando se utilice la variable de entorno, se aplicará:
-
Haga clic en el ícono
; -
Selecciona el certificado registrado en la pantalla Certificates.
Para importar un mapa de otro entorno:
-
Haga clic en el botón IMPORT MAP;
-
Selecciona el nombre del entorno que contiene el mapa y el sistema cargará los mapas existentes;
-
Después de seleccionar el mapa, haga clic en IMPORT MAP.
Se cargarán las variables de entorno. Podrá:
-
verlas haciendo clic en el icono para ampliar la pestaña junto al nombre del mapa;
-
editarlas haciendo clic en el ícono
; -
eliminarlas haciendo clic en el ícono
; -
agregar nuevas variables a un mapa haciendo clic en el ícono
y luego en el botón +.
En esta misma pestaña, puede editar el nombre y la descripción del mapa, o eliminarlo.
Gestión de variables de entorno
Cuando se crean variables en un entorno, estas se asocian al entorno en su conjunto, y no a una API específica. Por eso es importante seguir buenas prácticas de gestión y organización. Recomendamos que utilice un estándar de nomenclatura claro y coherente para todas las variables. Así será más fácil identificarlas y utilizarlas correctamente.
Ejemplo de uso
Considere dos variables de entorno: destination, con una dirección válida, y rateLimit, con el valor 2.
La variable de entorno $destination puede utilizarse como endpoint de una API.
Cuando se realiza una petición, el gateway dirigirá la llamada a la dirección informada.
Para ello, solo necesita hacer referencia a esta variable de entorno como el Target Destination de la API, como se muestra en la imagen a continuación.
La variable de entorno $rateLimit puede utilizarse en el interceptor del mismo nombre para establecer el límite de llamadas, anulando el valor configurado (en este caso, 2).
|
Share your suggestions with us!
Click here and then [+ Submit idea]