Referência de configuração do pacote de fluxo compartilhado

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Um fluxo compartilhado é uma funcionalidade reutilizável de maneira semelhante a um proxy de API. Para mais informações, consulte Como criar fluxos compartilhados reutilizáveis.

Estrutura de diretórios do pacote de fluxo compartilhado

A estrutura de diretórios do pacote de fluxo compartilhado, mostrada abaixo, é semelhante à estrutura de diretórios de configuração do proxy da API.

Estrutura de diretórios do pacote de fluxo compartilhado

Uma configuração de pacote de fluxo compartilhado consiste no seguinte conteúdo:

Configuração básica Configurações principais.
Políticas Arquivos de configuração formatados em XML que estão em conformidade com os esquemas de políticas do Apigee.
Recursos Scripts, arquivos JAR e arquivos XSLT referenciados por políticas para executar a lógica personalizada.
Fluxos compartilhados Fluxos compartilhados incluídos neste pacote.

Configuração básica

O arquivo de configuração básica está localizado no diretório raiz do pacote. Ele tem o mesmo nome do pacote.

/sharedflowbundle/traffic-management-shared.xml

A configuração básica define o conteúdo do pacote de fluxo compartilhado junto com as informações para rastrear o histórico de revisões do pacote.

<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 da configuração básica

Nome Descrição Padrão Obrigatório?
SharedFlowBundle
name Nome do pacote de fluxo compartilhado, que precisa ser único em uma organização. Os caracteres válidos incluem: A-Za-z0-9_- N/A Sim
revision Número da revisão da configuração do pacote de fluxo compartilhado. Não é necessário definir explicitamente o número da revisão, já que a Apigee rastreia automaticamente a revisão atual do fluxo compartilhado. N/A Não

Elementos de configuração básica

Nome Descrição Padrão Obrigatório?
SharedFlowBundle
ConfigurationVersion Versão do esquema de configuração do pacote de fluxo compartilhado a que esse fluxo de compartilhamento está em conformidade. O único valor aceito atualmente é majorVersion 4 e minorVersion 0. Essa configuração pode ser usada no futuro para permitir a evolução do formato do pacote de fluxo compartilhado. 4.0 Não
CreatedAt e CreatedBy Data/hora (no horário de época) em que o pacote de fluxo compartilhado foi criado e o e-mail do usuário que o criou.
Description Descrição textual do fluxo compartilhado. Se inserida, a descrição será exibida na IU do Apigee. N/A Não
DisplayName Nome fácil de usar que pode ser diferente do atributo name da configuração do fluxo compartilhado. N/A Não
LastModifiedAt e LastModifiedBy Data/hora (em horário de época) em que o pacote de fluxo compartilhado foi modificado pela última vez, junto com o e-mail do usuário que o modificou.
Policies Lista de políticas no diretório /policies deste fluxo compartilhado. Normalmente, você só verá esse elemento quando o fluxo compartilhado foi criado usando a IU de gerenciamento do Edge. Essa é apenas uma configuração de "manifesto" projetada para fornecer visibilidade ao conteúdo do fluxo compartilhado. N/A Não
Resources Lista de recursos (JavaScript, Python, Java, XSLT) no diretório /resources deste fluxo compartilhado. Normalmente, você só verá esse elemento quando o fluxo compartilhado foi criado usando a IU da Apigee. Essa é apenas uma configuração de manifesto projetada para fornecer visibilidade ao conteúdo do fluxo compartilhado. N/A Não
SharedFlows Fluxo compartilhado que este pacote contém. N/A Sim

Políticas

/sharedflowbundle/policies

Como em um proxy de API, em um pacote de fluxo compartilhado, o diretório /policies contém um XML de configuração para todas as políticas disponíveis para serem anexadas ao fluxo compartilhado no pacote. As políticas compartilham um subconjunto de elementos, mas esse subconjunto é ampliado com elementos específicos da política. Para saber mais sobre como configurar uma política, consulte Visão geral de referência da política.

Recursos

/sharedflowbundle/resources

Recursos são scripts, código e transformações XSL que podem ser anexados a fluxos compartilhados usando políticas. Eles aparecem na seção "Scripts" do editor de fluxo compartilhado na IU do gerenciamento.

Consulte Como gerenciar recursos para saber os tipos de recurso compatíveis.

Fluxos compartilhados

/sharedflowbundle/sharedflows/default.xml

A configuração SharedFlow define a sequência em que os elementos do fluxo são executados. Cada elemento <Step> filho do elemento <SharedFlow> especifica uma parte da sequência, como uma chamada para uma política.

A seguinte configuração de SharedFlow especifica três políticas a serem executadas em uma sequência de cima para baixo (da esquerda para a direita no console de gerenciamento), com a política SpikeArrest primeiro e um Política FlowCallout por último.

<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 configuração de fluxo compartilhado

Nome Descrição Padrão Obrigatório?
SharedFlow
name O nome do fluxo compartilhado, que precisa ser único em uma organização. Os caracteres válidos incluem: A-Za-z0-9_- N/A Sim
revision Número da revisão da configuração do fluxo compartilhado. Não é necessário definir explicitamente o número da revisão, já que a Apigee rastreia automaticamente a revisão atual do fluxo compartilhado. N/A Não

Elementos da configuração do fluxo compartilhado

Nome Descrição Padrão Obrigatório?
SharedFlow Sequência de políticas no fluxo compartilhado. N/A Sim
Step Estágio na sequência do fluxo. N/A Sim
Name Nome do item referenciado pela etapa. O valor desse elemento precisa ser igual ao identificador único do item, como o valor do atributo de nome de uma política. N/A Sim