Padrões do manual de proxy de API

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

Neste tópico, discutimos 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 do JavaScript

O padrão de cliente HTTP do 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 extrair resultados usando JavaScript.

Padrão de composição da política

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

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

O exemplo de manual de políticas de composição usa três políticas: AssignMessage, ServiceCallout e ExtractVariables. Essas políticas encapsulam as mensagens de solicitação que você quer enviar ao back-end, o cliente que encaminha a mensagem ao 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 são feitas, as variáveis coletadas sã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 cabeçalhos HTTP e parâmetros de consulta, 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 conferir um exemplo completo que demonstra o padrão de composição de políticas.