Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
Este tópico lista algumas características básicas dos proxies da API, além de links para mais informações.
As APIs são pontos de entrada para um aplicativo usar os recursos de outro. Você implementa proxies de API para criar APIs
No Apigee Edge, você implementa proxies de API configurando a lógica do proxy de API como uma sequência de etapas executadas em resposta a uma solicitação do código do cliente. Você expõe um proxy de API aos clientes definindo endpoints que incluem um URL com caminhos de recursos, um verbo HTTP, requisitos do corpo e assim por diante.
Embora seja chamado de proxy de API, a partir da perspectiva do código do cliente, é a API.
Para uma visão geral dos proxies da API, consulte Noções básicas sobre APIs e proxies de API.
Você organiza a sequência da lógica de proxy da API usando fluxos
Em qualquer aplicativo, os dados passam pelo aplicativo guiado pela lógica de condição. No Apigee Edge, o caminho de processamento é composto de fluxos. Um fluxo é uma sequência de estágios (ou "etapas") que compõem o caminho de processamento de um proxy de API. Os fluxos são a maneira como o Apigee Edge fornece locais para que você aplique lógica e comportamento em locais específicos do cliente ao recurso de back-end e, em seguida, de volta ao cliente.
Para mais informações sobre fluxos, consulte Como controlar a execução de um proxy com fluxos
Você acessa dados de estado por meio de variáveis de fluxo criadas por proxies de API
Um proxy de API tem acesso a variáveis que representam o estado de execução. Você pode acessar essas variáveis no XML que configura as políticas e os proxies da API. Você também pode acessá-los quando estiver estendendo um proxy de API com uma linguagem de procedimentos, como Java, JavaScript ou Python.
Essas variáveis são mantidas pelo Apigee Edge. Alguns existem por padrão, geralmente porque eles são comuns ao que proxies de API fazem, como porque fazem parte de uma solicitação HTTP. É possível também criar suas próprias variáveis para satisfazer um requisito de lógica.
Para mais informações sobre variáveis, consulte Como gerenciar o estado de proxy com variáveis de fluxo.
Os proxies de API podem ser executados de maneira condicional
Assim como na maioria das linguagens de programação, em proxies de API, o código pode ser executado condicionalmente. As condições geralmente são baseadas no estado do proxy da API, que pode ser acessado por meio de variáveis de fluxo. Por exemplo, você pode ter uma condição que verifica o user agent e, em seguida, processa a solicitação de acordo.
Para mais informações sobre execução condicional, consulte Variáveis e condições do fluxo.
Você implementa a maior lógica em um proxy de API usando políticas.
A maior parte da lógica adicionada a um proxy da API é empacotada como políticas. Uma política é um componente do Apigee Edge que encapsula a lógica para uma área funcional, como gerenciamento de segurança ou de tráfego. Você configura uma política com XML que define propriedades para a lógica subjacente. Você organiza as políticas em uma sequência de "etapas" dentro de um fluxo, para que o proxy da API execute a lógica na melhor ordem para as metas do proxy.
Para saber mais sobre políticas, consulte O que é a política de conteúdo?.
Você pode incluir conjuntos reutilizáveis de funcionalidades
Quando o proxy da API inclui lógica que será usada a partir de vários locais do seu código (como outros proxies da API), é possível coletar essa lógica para chamadas de vários locais. Por exemplo, é possível agrupar a lógica de segurança em um fluxo compartilhado chamado por outros proxies da API, reduzindo a duplicação entre os proxies da API.
Para saber mais sobre fluxos compartilhados, consulte Fluxos reutilizáveis compartilhados. Para saber mais sobre cadeia de proxy de API, consulte Como unir proxies de API.
É possível depurar um proxy com a ferramenta Trace
O Apigee Edge inclui uma ferramenta Trace que você pode usar para examinar o fluxo de execução do seu proxy de API ao depurar e testar. A ferramenta apresenta visualmente cada etapa do proxy da API que é executada para uma solicitação. Como em um depurador, em cada etapa, você pode ver a lista de valores de variáveis que compõem o estado do proxy da API.
Para saber mais sobre a depuração com o Trace, consulte Como usar a ferramenta Trace.
Tratamento de erros de proxy de API como falhas
Ao configurar um gerenciador de falhas, é possível personalizar o erro retornado para um cliente da API. Os gerenciadores de falhas oferecem controle sobre as mensagens de erro, independentemente de o erro ter origem no seu próprio código ou de um componente incluído (como uma política).
Para mais informações, consulte Como lidar com falhas.