Esta página foi traduzida pela API Cloud Translation.

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

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X. informações

Um fluxo compartilhado é uma funcionalidade reutilizável de maneira semelhante a um proxy de API. Grande parte do conteúdo desta referência será conhecido se você já estiver familiarizado com os proxies da API.

Se você estiver aprendendo a criar um fluxo compartilhado, comece pelo tópico Fluxos compartilhados reutilizáveis.

Estrutura de pacote de fluxo compartilhado

Um pacote de fluxo compartilhado tem a seguinte configuração:

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

Os componentes na tabela acima são definidos por arquivos de configuração na estrutura do diretório a seguir:

Arquivos de configuração e estrutura de diretórios de um pacote de fluxo compartilhado

Nesta seção, explicamos os arquivos de configuração e a estrutura de diretórios de um pacote de fluxo compartilhado.

Configuração básica
Políticas
Fluxos compartilhados
Recursos

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`	O nome do pacote de fluxo compartilhado, que precisa ser único em uma organização. Os caracteres permitidos no nome são restritos ao seguinte: `A-Za-z0-9_-`	N/A	Sim
`revision`	O 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 Edge 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`	A versão do esquema de configuração do pacote de fluxo compartilhado a que esse fluxo de compartilhamento está em conformidade. Atualmente, o único valor compatível é 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`	A data/hora (em horário de época) em que o pacote de fluxo compartilhado foi criado, junto com o e-mail do usuário que o criou.
`Description`	Uma descrição textual do fluxo compartilhado. Se fornecido, a descrição será exibida na IU de gerenciamento do Edge.	N/A	Não
`DisplayName`	Um 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`	A 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`	Uma 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`	Uma 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 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
`SharedFlows`	Especifica o fluxo compartilhado que esse pacote contém. No momento, esse elemento é compatível com apenas um <SharedFlow> filho. Somente um fluxo compartilhado pode ser adicionado a um pacote.	N/A	Sim

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 Spike Arrest primeiro e um Política de chamada de fluxo 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 permitidos no nome são restritos ao seguinte: `A-Za-z0-9_-`	N/A	Sim
`revision`	O 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 Edge 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`	Define a sequência de políticas no fluxo compartilhado.	N/A	Sim
`Step`	Define um passo: um estágio na sequência do fluxo.	N/A	Sim
`Name`	Especifica o nome do item referenciado pelo passo. 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

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 mais informações sobre como configurar uma política, consulte o tópico sobre a política desejada. Também é possível acessá-los na 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 Arquivos de recursos para conhecer os tipos de recursos compatíveis.

Poste suas dúvidas no Fórum de desenvolvedores da Apigee.