Referência de configuração do pacote de fluxos partilhados

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Um fluxo partilhado é uma funcionalidade reutilizável semelhante a um proxy de API. Para mais informações, consulte o artigo Crie fluxos partilhados reutilizáveis.

Estrutura do diretório do pacote de fluxos partilhados

A estrutura do diretório do pacote de fluxo partilhado, apresentada abaixo, é semelhante à estrutura do diretório de configuração do proxy da API.

Estrutura do diretório do pacote de fluxos partilhados

Uma configuração do conjunto de fluxos partilhados consiste nos seguintes conteúdos:

Configuração base Definições de configuração principais.
Políticas Ficheiros de configuração formatados em XML que estão em conformidade com os esquemas de políticas do Apigee.
Resources Scripts, ficheiros JAR e ficheiros XSLT referenciados por políticas para executar lógica personalizada.
Fluxos partilhados Fluxos partilhados incluídos neste pacote.

Configuração base

O ficheiro de configuração base está localizado no diretório raiz do pacote. O nome é o nome do conjunto.

/sharedflowbundle/traffic-management-shared.xml

A configuração base define o conteúdo do pacote de fluxo partilhado, juntamente com informações para acompanhar 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 de configuração base

Nome Descrição Predefinição Obrigatório?
SharedFlowBundle
name Nome do pacote de fluxos partilhados, que tem de ser exclusivo numa organização. Os carateres válidos incluem: A-Za-z0-9_- N/A Sim
revision Número de revisão da configuração do pacote de fluxos partilhados. Não tem de definir explicitamente o número de revisão, uma vez que o Apigee acompanha automaticamente a revisão atual do fluxo partilhado. N/A Não

Elementos de configuração base

Nome Descrição Predefinição Obrigatório?
SharedFlowBundle
ConfigurationVersion Versão do esquema de configuração do pacote de fluxos partilhados ao qual este fluxo partilhado está em conformidade. Atualmente, os únicos valores suportados são majorVersion 4 e minorVersion 0. Esta definição pode ser usada no futuro para permitir a evolução do formato do pacote de fluxo partilhado. 4,0 Não
CreatedAt e CreatedBy Data/hora (no formato de tempo epoch) em que o pacote de fluxo partilhado foi criado e o email do utilizador que o criou.
Description Descrição textual do fluxo partilhado. Se for fornecida, a descrição é apresentada na IU do Apigee. N/A Não
DisplayName Nome simples que pode ser diferente do atributo name da configuração do fluxo partilhado. N/A Não
LastModifiedAt e LastModifiedBy Data/hora (no formato de tempo de época) em que o conjunto de fluxos partilhados foi modificado pela última vez, juntamente com o email do utilizador que o modificou.
Policies Lista de políticas no diretório /policies deste fluxo partilhado. Normalmente, só vê este elemento quando o fluxo partilhado foi criado através da IU de gestão do Edge. Esta é simplesmente uma definição de "manifesto", concebida para fornecer visibilidade sobre o conteúdo do fluxo partilhado. N/A Não
Resources Lista de recursos (JavaScript, Python, Java, XSLT) no diretório /resources deste fluxo partilhado. Normalmente, só vê este elemento quando o fluxo partilhado foi criado através da IU do Apigee. Esta é simplesmente uma definição do manifesto, concebida para oferecer visibilidade sobre o conteúdo do fluxo partilhado. N/A Não
SharedFlows Fluxo partilhado que este pacote contém. N/A Sim

Políticas

/sharedflowbundle/policies

Tal como num proxy de API, num pacote de fluxo partilhado, o diretório /policies contém XML de configuração para todas as políticas disponíveis para serem anexadas ao fluxo partilhado no pacote. As políticas partilham um subconjunto de elementos, embora este subconjunto seja aumentado com elementos específicos da política. Para mais informações sobre como configurar uma política, Vista geral da referência de políticas.

Recursos

/sharedflowbundle/resources

Os recursos são scripts, código e transformações XSL que podem ser anexados a fluxos partilhados através de políticas. Estes aparecem na secção Scripts do editor de fluxos partilhados na IU de gestão.

Consulte o artigo Gerir recursos para ver os tipos de recursos compatíveis.

Fluxos partilhados

/sharedflowbundle/sharedflows/default.xml

A configuração do SharedFlow define a sequência em que os elementos do fluxo devem ser executados. Os elementos secundários <Step> do elemento <SharedFlow> especificam cada um uma parte da sequência, como uma chamada a uma política.

A seguinte configuração do SharedFlow especifica três políticas a serem executadas numa sequência de cima para baixo (da esquerda para a direita na consola de gestão), com a política SpikeArrest primeiro e uma 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 do fluxo partilhado

Nome Descrição Predefinição Obrigatório?
SharedFlow
name O nome do fluxo partilhado, que tem de ser exclusivo numa organização. Os carateres válidos incluem: A-Za-z0-9_- N/A Sim
revision Número de revisão da configuração do fluxo partilhado. Não tem de definir explicitamente o número de revisão, uma vez que o Apigee acompanha automaticamente a revisão atual do fluxo partilhado. N/A Não

Elementos de configuração do fluxo partilhado

Nome Descrição Predefinição Obrigatório?
SharedFlow Sequência de políticas no fluxo partilhado. N/A Sim
Step Fase na sequência do fluxo. N/A Sim
Name Nome do artigo referenciado pelo passo. O valor deste elemento deve ser igual ao identificador único do item, como o valor do atributo name de uma política. N/A Sim