Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Este tópico apresenta algumas características básicas dos proxies de API, juntamente com links para mais informações.
As APIs são pontos de entrada para uma aplicação usar as capacidades de outra. Implementa proxies de API para criar APIs
No Apigee, implementa proxies de API configurando a lógica do proxy de API como uma sequência de passos que são executados em resposta a um pedido do código do cliente. Expõe um proxy de API aos clientes definindo pontos finais que incluem um URL com caminhos de recursos, um verbo HTTP, requisitos do corpo, e assim sucessivamente.
Embora se chame proxy de API, do ponto de vista do código do cliente, é a API.
Para uma vista geral dos proxies de API, consulte o artigo Compreender as APIs e os proxies de API.
Organiza a sequência da lógica do proxy de API através de fluxos
Em qualquer aplicação, os dados fluem através da aplicação orientados pela lógica de condições. No Apigee, o caminho de processamento é composto por fluxos. Um fluxo é uma sequência de fases (ou "passos") que compõem o caminho de processamento de um proxy de API. Os fluxos são a forma como o Apigee lhe oferece locais para aplicar 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 o artigo Controlar como um proxy é executado com fluxos
Aceder aos dados de estado através 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. Pode aceder a estas variáveis a partir do XML que configura os proxies de API e as políticas. Também pode aceder a estas quando estende um proxy de API com uma linguagem processual, como Java, JavaScript ou Python.
Estas variáveis são detidas pelo Apigee. Alguns existem por predefinição, normalmente porque são comuns ao que os proxies de API fazem (por exemplo, porque fazem parte de um pedido HTTP). Também pode criar as suas próprias variáveis para satisfazer um requisito lógico.
Para saber mais sobre as variáveis, consulte o artigo Gerir o estado do proxy com variáveis de fluxo.
Pode fazer com que os proxies de API sejam executados condicionalmente
Tal como na maioria das linguagens de programação, nos proxies de API, pode executar código condicionalmente. As condições baseiam-se frequentemente no estado do proxy da API, ao qual pode aceder através de variáveis de fluxo. Por exemplo, pode ter uma condição que verifique o agente do utilizador e, em seguida, processe o pedido em conformidade.
Para mais informações sobre a execução condicional, consulte o artigo Condições com variáveis de fluxo.
Implementa a maioria da lógica num proxy de API através de políticas
A maior parte da lógica que adiciona a um proxy de API é incluída em pacotes como políticas. Uma política é um componente do Apigee que encapsula a lógica de uma área funcional, como a segurança ou a gestão de tráfego. Configura uma política com XML que define propriedades para a lógica subjacente. Organiza as políticas numa sequência de "passos" num fluxo, para que o proxy de API execute a lógica na melhor ordem para os objetivos do seu proxy.
Para saber mais sobre as políticas, consulte o artigo O que é uma política?.
Pode incluir conjuntos reutilizáveis de funcionalidade
Quando o proxy de API inclui lógica que vai ser usada a partir de vários locais no seu código, como outros proxies de API, pode recolher essa lógica para chamadas de vários locais. Por exemplo, pode agrupar a lógica de segurança num fluxo partilhado que outros proxies de API chamam, reduzindo a duplicação nos proxies de API.
Para mais informações sobre fluxos partilhados, consulte o artigo Fluxos partilhados reutilizáveis. Para mais informações sobre o encadeamento de proxies de API, consulte o artigo Encadeamento de proxies de API em conjunto.
Pode depurar um proxy com a ferramenta de depuração
O Apigee inclui uma ferramenta de depuração que pode usar para examinar o fluxo de execução do proxy de API ao depurar e testar. A ferramenta apresenta visualmente cada passo do proxy de API que é executado para um pedido. Tal como num depurador, em cada passo, pode ver a lista de valores das variáveis que compõem o estado do proxy da API.
Para mais informações sobre a depuração com a ferramenta de depuração, consulte o artigo Ferramenta de depuração.
Trata os erros de proxy da API como falhas
Ao configurar um controlador de falhas, pode personalizar o erro devolvido a um cliente da API. Os processadores de falhas dão-lhe controlo sobre as mensagens de erro, quer o erro tenha origem no seu próprio código ou num componente incluído (como uma política).
Para mais informações, consulte o artigo Processamento de falhas.