Padrões do manual de proxy de API

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
info

Este tópico discute alguns dos padrões de desenvolvimento de proxy de API demonstrados nos exemplos do livro de receitas do Apigee Edge. À medida que adicionamos mais exemplos de livros de receitas, planejamos adicionar mais padrões a este tópico.

O padrão de cliente HTTP JavaScript

O padrão de cliente HTTP JavaScript é um dos vários padrões que podem ser usados para criar mashups do lado do servidor com o Apigee Edge. O modelo de objeto JavaScript da Apigee permite conectar o código JavaScript diretamente a um fluxo de proxy de API. O objeto httpClient do modelo de objeto permite fazer chamadas para serviços de back-end e recuperar resultados usando JavaScript.

O padrão de composição de políticas

A composição de políticas é um padrão de proxy de API da Apigee que permite combinar resultados de vários destinos de back-end em uma única resposta usando políticas. Na verdade, a composição de políticas permite criar mashups usando políticas.

No centro do padrão de composição de políticas está a política ServiceCallout. A política ServiceCallout atua como um cliente HTTP para a API ou serviço de back-end. No entanto, para ser totalmente funcional, uma ServiceCallout depende de outras políticas para permitir uma interação significativa com uma API ou serviço remoto. Outras políticas são usadas para gerar a mensagem de solicitação enviada pela ServiceCallout e para analisar o conteúdo na mensagem de resposta da API ou serviço remoto.

O exemplo do livro de receitas de composição de política usa três políticas: AssignMessage, ServiceCallout, e ExtractVariables. Essas políticas encapsulam as mensagens de solicitação que você quer enviar para o back-end, o cliente que encaminha a mensagem para o back-end e um analisador de mensagens que analisa a resposta de cada API e atribui variáveis aos dados de resposta. Depois que todas as chamadas forem feitas, as variáveis coletadas serão combinadas e retornadas em um único objeto JSON.

Confira um resumo dessas três políticas:

  • AssignMessage: cria uma mensagem de solicitação, preenche os cabeçalhos HTTP e os parâmetros de consulta e define o verbo HTTP.
  • ServiceCallout: refere-se a uma mensagem criada pela política AssignMessage , define um URL de destino para a chamada externa e define um nome para o objeto de resposta retornado pelo serviço de destino.
  • ExtractVariables: normalmente, define uma expressão JSONPath ou XPath que analisa a mensagem gerada pela política ServiceCallout anterior. Em seguida, a política define variáveis que contêm os valores analisados da resposta da ServiceCallout.

Consulte Como usar a composição de políticas para ver um exemplo completo que demonstra o padrão de composição de políticas.