Referencia de configuración del paquete de flujo compartido

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

Un flujo compartido es una funcionalidad reutilizable similar a un proxy de API. Gran parte del contenido de esta referencia te resultará familiar si ya estás familiarizado con los proxies de API.

Si estás aprendiendo a compilar un flujo compartido, comienza con el tema Flujos compartidos reutilizables.

Estructura del paquete de flujo compartido

Un paquete de flujo compartido consiste en la siguiente configuración:

Configuración básica Configuración principal. Consulta Configuración básica.
Políticas Archivos de configuración con formato XML que cumplen con los esquemas de políticas de Apigee Edge. Consulta Políticas.
Recursos Secuencias de comandos, archivos JAR y archivos XSLT a los que hacen referencia las políticas para ejecutar la lógica personalizada. Consulta recursos.
SharedFlows Flujos compartidos incluidos en este paquete. Consulta Flujos compartidos.

Los componentes de la tabla anterior se definen mediante los archivos de configuración en la siguiente estructura de directorio:

Archivos de configuración y estructura de directorio de un paquete de flujo compartido

En esta sección, se explican los archivos de configuración y la estructura de directorio de un paquete de flujo compartido.

Configuración básica

El archivo de configuración básica se encuentra en el directorio raíz del paquete. Su nombre es el nombre del paquete.

/sharedflowbundle/traffic-management-shared.xml

La configuración básica define el contenido del paquete de flujo compartido, junto con la información sobre el seguimiento del historial de revisiones del paquete.

<SharedFlowBundle revision="2" name="traffic-management-shared">
    <ConfigurationVersion majorVersion="4" minorVersion="0"/>
    <CreatedAt>1478637529218</CreatedAt>
    <CreatedBy>gladys@example.com</CreatedBy>
    <Description>Shared flow to moderate API traffic</Description>
    <DisplayName>traffic-management-shared</DisplayName>
    <LastModifiedAt>1481573374023</LastModifiedAt>
    <LastModifiedBy>gladys@example.com</LastModifiedBy>
    <Policies>
        <Policy>Auth-Flow-Callout</Policy>
        <Policy>Extract-Token</Policy>
        <Policy>Spike-Arrest</Policy>
    </Policies>
    <Resources>
        <Resource>jsc://extract-token.js</Resource>
    </Resources>
    <SharedFlows>
        <SharedFlow>default</SharedFlow>
    </SharedFlows>
</SharedFlowBundle>

Atributos de configuración base

Name Descripción Predeterminada ¿Es obligatorio?
SharedFlowBundle
name Es el nombre del paquete del flujo compartido, que debe ser único dentro de la organización. Los caracteres que puedes usar en el nombre están restringidos a los siguientes: A-Za-z0-9_- N/A Sí
revision Es el número de revisión de la configuración del paquete de flujo compartido. No es necesario que configures de forma explícita el número de revisión, ya que Apigee Edge realiza un seguimiento automático de la revisión actual del flujo compartido. N/A No

Elementos de la configuración base

Name Descripción Predeterminada ¿Es obligatorio?
SharedFlowBundle
ConfigurationVersion Es la versión del esquema de configuración del paquete de flujo compartido con el que cumple este flujo compartido. Por el momento, el único valor admitido es majorVersion 4 y minorVersion 0. Esta configuración se puede usar en el futuro para habilitar la evolución del formato del paquete de flujo compartido. 4.0 No
CreatedAt y CreatedBy Es la fecha y hora (en época) que se creó el paquete de flujo compartido, junto con el correo electrónico del usuario que lo creó.
Description Es una descripción textual del flujo compartido. Si se proporciona, la descripción se mostrará en la IU de administración de Edge. N/A No
DisplayName Es un nombre fácil de usar que puede ser diferente del atributo name de la configuración de flujo compartido. N/A No
LastModifiedAt y LastModifiedBy Fecha y hora (en época) en que el conjunto de flujo compartido se modificó por última vez, junto con el correo electrónico del usuario que lo modificó.
Policies Es una lista de políticas en el directorio /policies de este flujo compartido. Por lo general, solo verás este elemento cuando se cree el flujo compartido mediante la IU de administración de Edge. Solo se trata de una configuración de “manifiesto”, diseñada para proporcionar visibilidad del contenido del flujo compartido. N/A No
Resources Una lista de recursos (JavaScript, Python, Java, XSLT) en el directorio /resources de este flujo compartido. Por lo general, solo verás este elemento cuando se cree el flujo compartido mediante la IU de administración de Edge. Solo se trata de una configuración de “manifiesto”, diseñada para proporcionar visibilidad del contenido del flujo compartido. N/A No
SharedFlows Especifica el flujo compartido que contiene este paquete.

Ten en cuenta que, en la actualidad, este elemento solo admite un elemento <SharedFlow> secundario. Solo se puede agregar un flujo compartido a un paquete de flujo compartido.

 N/A Sí

Flujos compartidos

/sharedflowbundle/sharedflows/default.xml

La configuración de SharedFlow define la secuencia en la que se deben ejecutar los elementos del flujo. Los elementos secundarios <Step> del elemento <SharedFlow> especifican una parte de la secuencia, como una llamada a una política.

La siguiente configuración de SharedFlow especifica tres políticas que se ejecutarán en una secuencia de arriba abajo (de izquierda a derecha en la consola de administración), con la política de Spike Arrest primero y una política de texto destacado de flujo al final.

<SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
    <Step>
        <Name>Extract-Token</Name>
    </Step>
    <Step>
        <Name>Auth-Flow-Callout</Name>
    </Step>
</SharedFlow>

Atributos de configuración de flujo compartido

Name Descripción Predeterminada ¿Es obligatorio?
SharedFlow
name Es el nombre del flujo compartido, que debe ser único dentro de la organización. Los caracteres que puedes usar en el nombre están restringidos a los siguientes: A-Za-z0-9_- N/A Sí
revision Es el número de revisión de la configuración de flujo compartido. No es necesario que configures de forma explícita el número de revisión, ya que Apigee Edge realiza un seguimiento automático de la revisión actual del flujo compartido. N/A No

Elementos de configuración de flujo compartido

Name Descripción Predeterminada ¿Es obligatorio?
SharedFlow Define la secuencia de políticas en el flujo compartido. N/A Sí
Step Define un paso, es decir, una etapa en la secuencia del flujo. N/A Sí
Name Especifica el nombre del elemento al que se hace referencia en el paso. El valor de este elemento debe ser el mismo que el identificador único del elemento, como el valor del atributo de nombre de la política. N/A Sí

Políticas

/sharedflowbundle/policies

Al igual que en un proxy de API, en el paquete de flujo compartido, el directorio de /policies contiene XML de configuración para todas las políticas disponibles que se pueden adjuntar al flujo compartido en el paquete. Las políticas comparten un subconjunto de elementos, aunque este subconjunto aumenta con los elementos específicos de la política. Si deseas obtener más información para configurar una política, consulta el tema sobre la política que deseas. También puedes acceder a ellos desde la descripción general de la referencia de políticas.

Recursos

/sharedflowbundle/resources

Los recursos son secuencias de comandos, códigos y transformaciones XSL que se pueden adjuntar a flujos compartidos con políticas. Estos aparecen en la sección de secuencias de comandos del editor de flujo compartido en la IU de administración.

Consulta Archivos de recursos para conocer los tipos de recursos admitidos.

Publica tus preguntas en el Foro para desarrolladores de Apigee.