Esta página se aplica à Apigee e à Apigee híbrida.
Confira a documentação da
Apigee Edge.
Os fluxos compartilhados executam pré-processamento de solicitações boilerplate ou pós-processamento de respostas em um conjunto de APIs. Com um gancho de fluxo, você anexa um fluxo compartilhado para que ele seja executado no mesmo lugar para todos os proxies de API implantados em um ambiente específico. Isso gera uma sequência de lógica implementada e implantada separadamente que não faz parte do código de implementação de um proxy.
Como o código anexado a um gancho de fluxo está fora do contexto da lógica principal do proxy de API, parte do comportamento dele é diferente dos proxies de API. Lembre-se:
- Você precisa ter permissão para anexar um fluxo compartilhado a um gancho de fluxo. Você precisa ser um administrador da organização.
- É possível anexar apenas um fluxo compartilhado a cada gancho de fluxo.
- É possível anexar o mesmo fluxo compartilhado a vários ganchos de fluxo.
- Se o fluxo compartilhado anexado a um gancho de fluxo gerar uma falha ou houver erros durante a execução do fluxo compartilhado, a mensagem será rejeitada e a falha será enviada ao autor da chamada.
- Se uma mensagem for rejeitada durante a execução de um gancho de fluxo, os detalhes serão registrados na análise no contexto do proxy chamado. O fluxo compartilhado também pode gerar uma falha com um código personalizado e uma mensagem de erro
O vídeo a seguir demonstra como conectar um fluxo compartilhado a um gancho de fluxo e rastreá-lo na IU da Apigee.
Um fluxo compartilhado anexado a um proxy por meio de um gancho de fluxo é um ótimo lugar para lógica que impõe requisitos amplos de política. Por exemplo, imagine que você tenha uma equipe gerenciando um único conjunto de requisitos de segurança para várias equipes que representam linhas diferentes de empresas (LOBs, na sigla em inglês). Cada equipe do LOB pode desenvolver APIs de acordo com os próprios requisitos e sem precisar considerar os requisitos de segurança mais amplos. A equipe de segurança pode implementar esses requisitos de segurança em um fluxo compartilhado e, em seguida, anexá-los ao ambiente da Apigee usando um gancho de fluxo. Como o fluxo compartilhado não faz parte do código proxy, a equipe de segurança pode analisá-lo conforme necessário sem interferir no código do LOB.
Os fluxos compartilhados anexados por meio de ganchos de fluxo são executados nessa posição para todos os proxies de API implantados no ambiente do gancho de proxy. Por esse motivo, a capacidade de usar ganchos de fluxo está disponível apenas para administradores de uma organização da Apigee.
Para saber mais sobre fluxos compartilhados, consulte Fluxos compartilhados reutilizáveis.
Você anexa um fluxo compartilhado a um gancho de fluxo usando a IU da Apigee ou a API Flowhooks. É possível anexar no máximo um fluxo compartilhado a um gancho de fluxo em cada um dos locais a seguir:
-
Gancho de fluxo pré-proxy para lógica que precisa ser aplicada ANTES da execução de um endpoint de proxy.
Por exemplo, é possível ter lógica para impor a segurança em todas as APIs em um ambiente.
Gancho de fluxo pré-destino para lógica que precisa ser aplicada ANTES da execução de um endpoint de destino.
Por exemplo, é possível implementar a geração de registros antes que a solicitação chegue ao back-end. Também é possível aplicar a mediação removendo determinados campos da solicitação.
Gancho de fluxo pós-destino para lógica que precisa ser aplicada APÓS a execução da resposta.
Isso será aplicado logo após a resposta retornar do back-end. É possível usá-lo para registrar a resposta de back-end ou executar uma mediação removendo campos confidenciais dessa resposta.
Gancho de fluxo pós-proxy para a lógica que precisa ser aplicada APÓS o endpoint do proxy e logo antes da resposta ser enviada ao cliente.
Isso pode incluir alguma lógica de aplicação para o CORS, registrar a resposta ou executar um mashup ou formatação.
Como anexar um fluxo compartilhado a um gancho de fluxo
Para anexar um fluxo compartilhado a um gancho de fluxo, é necessário ser um administrador na organização que contém o fluxo compartilhado.
Apigee no console do Cloud
Para adicionar um fluxo compartilhado a um hook de fluxo:
- Abra https://console.cloud.google.com/apigee em um navegador.
- Selecione a organização que contém o fluxo compartilhado. Consulte
Como alternar entre suas organizações.
O fluxo compartilhado estará disponível para todos os proxies de API e fluxos compartilhados implantados em um ambiente dessa organização. Ele não estará disponível fora desta organização.
- No painel de navegação à esquerda, clique em Gerenciamento > Ambientes.
- Na lista de ambientes disponíveis, selecione aquele que você quer editar.
- Clique na guia Hooks de fluxo na página Detalhes do ambiente.
A visualização Hooks de fluxo é exibida.
- Na lista de hooks de fluxo, localize o hook ao qual você quer anexar o fluxo compartilhado.
O hook de fluxo escolhido depende de onde você quer que o fluxo compartilhado seja executado.
Local do hook de fluxo Descrição Pré-proxy Executa antes da execução de um endpoint de proxy. Pré-destino Executa antes da execução de um endpoint de destino. Pós-destino Executa depois que a resposta de destino é executada. Pós-proxy Executa depois do endpoint do proxy e logo antes da resposta ser enviada ao cliente - Na caixa de listagem do hook de fluxo escolhido, selecione o fluxo compartilhado que você quer anexar.
- Anexe fluxos compartilhados a outros hooks de fluxo conforme necessário.
- Clique em Salvar para anexar os fluxos compartilhados selecionados aos hooks de fluxo.
Apigee clássica
Para adicionar um fluxo compartilhado a um hook de fluxo:
- Faça login na IU da Apigee.
- Selecione a organização que contém o fluxo compartilhado. Consulte
Como alternar entre suas organizações.
O fluxo compartilhado estará disponível para todos os proxies de API e fluxos compartilhados implantados em um ambiente dessa organização. Ele não estará disponível fora desta organização.
- Selecione Administrador > Ambientes > Hooks de fluxo na barra de navegação à esquerda.
A visualização Hooks de fluxo exibe o seguinte:
- Na lista suspensa de ambiente, selecione o ambiente que você quer modificar.
- Na lista de hooks de fluxo, localize o hook ao qual você quer anexar o fluxo compartilhado.
O hook de fluxo escolhido depende de onde você quer que o fluxo compartilhado seja executado.
Local do hook de fluxo Descrição Pré-proxy Executa antes da execução de um endpoint de proxy. Pré-destino Executa antes da execução de um endpoint de destino. Pós-proxy Executa depois do endpoint do proxy e logo antes da resposta ser enviada ao cliente Pós-destino Executa depois que a resposta de destino é executada. - Posicione o cursor sobre o gancho de fluxo na lista para exibir a coluna de ações.
- Clique em Editar.
- Na caixa de diálogo Fluxo compartilhado, selecione o fluxo compartilhado que você quer anexar no menu Fluxo compartilhado.
- Clique em OK.
- Anexe fluxos compartilhados a outros hooks de fluxo conforme necessário.