Adjunta y configura políticas en archivos XML

Estás viendo la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Más información

Puedes crear y editar políticas de forma local con tu IDE o editor de texto o adaptado al XML favorito. En este tema, se usa el tipo de política de cuotas como ejemplo de cómo crear, configurar, adjuntar, implementar y probar políticas.

La mayoría de los proxies de API aplican una cuota. Las cuotas controlan la frecuencia con la que una app cliente puede invocar una API durante un intervalo de tiempo determinado. En el ejemplo siguiente, se configura una política de cuota para limitar las apps a 1 solicitud por minuto. (Si bien es posible que no sea realista, proporciona una forma simple de ver los efectos de una política).

En una configuración de proxy de API, los archivos de política se almacenan como archivos en formato XML en el directorio /apiproxy/policies.

Por ejemplo, se podría crear una política de tipo Quota llamada “QuotaPolicy” como un archivo llamado QuotaPolicy.xml con el siguiente contenido:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Puedes crear un archivo de texto a mano o generar la política a partir de un esquema XML. Todas las políticas tienen algunas opciones de configuración que son específicas del tipo de política y otras que son genéricas en todas las políticas.

Cuando adjuntas políticas en la IU de administración, el compilador de proxy de API genera la instancia de política desde el esquema XML para el tipo de política que seleccionaste. Por lo tanto, es posible que veas elementos en la configuración de la política que, para mayor claridad, no siempre se incluyen en la documentación.

Todas las políticas definen los siguientes atributos:

  • enabled: Indica si la política está activada o desactivada. Se pueden habilitar o inhabilitar las políticas durante el tiempo de ejecución si cambias esta configuración. No se aplica una política que tiene el parámetro enabled establecido en false.
  • continueOnError: define si la canalización debe continuar procesando el mensaje si la política falla. Cuando se aplican políticas de cuota, los errores indican que se superó la cuota y, por lo tanto, este atributo se debe configurar como falso.
  • name: es el nombre que le asignaste a esta política. Este nombre es exclusivo de esta instancia de política y se usa para adjuntar la política al flujo como un paso de procesamiento.

En el ejemplo anterior, los elementos Allow, Interval y TimeUnit son específicos de la política de cuotas. Estos elementos proporcionan una configuración que los servicios de API aplican en nombre de una API. Otros tipos de políticas definen su propia configuración, sobre la que puedes obtener información en la Referencia de políticas.