Información sobre las rutas

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

Una ruta determina la ruta de acceso de una solicitud desde ProxyEndpoint hasta TargetEndpoint. La URL que se usa para acceder al ProxyEndpoint de la API y la URL del servicio de backend definido por TargetEndpoint se incluyen en la ruta.

Determina la URL del extremo del proxy de API

En la siguiente imagen, se muestra una solicitud que llega al ProxyEndpoint desde una app y esa solicitud dirigida al servicio de backend:

Después de crear un proxy de API en Edge, la URL predeterminada que usa una app para acceder al proxy tiene el siguiente formato:

http://{org-name}-{env-name}.apigee.net/{base-path}/{resource-path}

https://{org-name}-{env-name}.apigee.net/{base-path}/{resource-path}

Donde:

• {org-name} es el nombre de su organización. Este nombre se crea cuando creas una cuenta en Edge.
• {env-name} es el nombre del entorno perimetral. De forma predeterminada, todas las organizaciones de Apigee creadas en la nube se aprovisionan con dos entornos: “test” y “prod”. Cuando implementes un proxy de API, puedes elegir implementarlo en uno o ambos entornos.
• {base-path} y {resource-path} se definen cuando creas el proxy de API.

Cuando llega una solicitud a Edge, Edge analiza la URL para dirigir la solicitud al ProxyEndpoint correcto. Por ejemplo, se usa la siguiente URL para acceder a un proxy de API en Edge:

http://myOrg-prod.apigee.net/v1/weather/forecastrss

Si examinas la definición de ProxyEndpoint del proxy de API en la figura anterior, puedes ver cómo Edge analiza esta URL:

1. La parte del dominio de la URL, http://myOrg-prod.apigee.net, corresponde a un host virtual en Edge. En la definición de ProxyEndpoint anterior, el proxy de API usa la etiqueta <VirtualHost> para hacer referencia a un host virtual llamado default. Puedes tener varios hosts virtuales definidos en tu entorno.
   
   Un host virtual define los dominios y los puertos en los que se expone un proxy de API. Un host virtual también define si se accede al proxy de API con el protocolo HTTP o con el protocolo HTTPS encriptado. Para obtener información detallada sobre los hosts virtuales, consulta Información acerca de los hosts virtuales (beta).
2. La segunda parte de la URL, /v1/weather, se determina mediante el elemento <BasePath> en ProxyEndpoint. La ruta base debe ser única para el proxy de API del entorno, de modo que dos proxies de API no tengan la misma ruta base.
3. La tercera parte de la URL, /forecastrss, es un recurso definido por el proxy de API con el flujo condicional correspondiente definido por la etiqueta <Flows>.

Determina la URL del extremo de destino

La etiqueta <RouteRule> en una definición de ProxyEndpoint determina el destino del proxy de API y se evalúa después de que se procesan todas las políticas en el flujo previo, los flujos condicionales y el flujo posterior de la solicitud de ProxyEndpoint.

Un ProxyEndpoint puede definir el destino de la siguiente manera:

• Una URL directa a un servicio de backend.
• Una sola definición de TargetEndpoint.
• Múltiples TargetEndpoints en los que el proxy de API delega la solicitud a un extremo de destino según una condición.
• Ruta o destino nulo, lo que significa que la solicitud no se reenvía a un destino. En cambio, todo el procesamiento de la solicitud y la generación de la respuesta se producen en Edge.

URL directa

Un ProxyEndpoint puede invocar directamente un servicio de backend, mediante la cual se puede omitir cualquier configuración de TargetEndpoint con nombre. Por ejemplo, la siguiente <RouteRule> siempre realiza una llamada HTTP a http://api.mycompany.com/myAPI:

<RouteRule name="default">
  <URL>http://api.mycompany.com/myAPI</URL> 
</RouteRule>

Sin embargo, como no hay un TargetEndpoint, solo puedes agregar políticas a los flujos que define ProxyEndpoint.

Objetivo único

En una definición de destino único, ProxyEndpoint hace referencia a una sola definición de TargetEndpoint por nombre, como se muestra en la figura anterior:

<RouteRule name="default">
  <TargetEndpoint>default</TargetEndpoint>
</RouteRule>

Todas las solicitudes a este proxy de API se dirigen a la misma definición de TargetEndpoint. La etiqueta <URL> en TargetEndpoint determina la ubicación del servicio de backend. En la figura anterior, la URL de destino es http://weather.yahooapis.com.

Objetivos condicionales

La etiqueta <RouteRule> te permite dirigir una solicitud a un destino según una condición. Puedes usar variables de flujo, parámetros de búsqueda, encabezados HTTP, contenido de mensajes o información contextual como la hora del día y la configuración regional para determinar el extremo de destino. Por ejemplo, puedes incluir un área geográfica, como EE.UU. y Reino Unido, en una URL de solicitud. Luego, puedes enrutar una solicitud a un extremo de destino en función de la región.

La siguiente regla de enrutamiento evalúa un encabezado HTTP en una solicitud. Si el encabezado HTTP routeTo tiene el valor TargetEndpoint1, la solicitud se reenvía al TargetEndpoint llamado TargetEndpoint1. De lo contrario, la solicitud se reenvía a TargetEndpoint2.

<RouteRule name="MyRoute">
  <Condition>request.header.routeTo = "TargetEndpoint1"</Condition>
  <TargetEndpoint>TargetEndpoint1</TargetEndpoint>
</RouteRule>
<RouteRule name="default">
 <TargetEndpoint>TargetEndpoint2</TargetEndpoint>
</RouteRule>

Si tienes varias reglas de enrutamiento, crea una como "predeterminada", es decir, como una regla de enrutamiento sin condición. Asegúrate de que la regla de ruta predeterminada se defina por última vez en la lista de rutas condicionales, ya que las reglas se evalúan de arriba a abajo en el ProxyEndpoint.

Consulta también Rutas condicionales y Referencia de condiciones.

Ruta nula

Una ruta nula admite situaciones en las que no es necesario reenviar el mensaje de solicitud a un TargetEndpoint. Esto es útil cuando el ProxyEndpoint realiza todo el procesamiento necesario, por ejemplo, con JavaScript para llamar a un servicio externo.

En el siguiente ejemplo, se define una ruta nula:

<RouteRule name="GoNowhere"/>

Más información

• Acerca de los hosts virtuales
• Referencia de la configuración del proxy de API
• Referencia de propiedades de extremos
• Balanceo de cargas entre servidores de backend