Padrões do manual de proxy de API

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

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 adicionarmos mais amostras de livros de receitas, planejamos adicionar mais padrões a este tópico.

O padrão do cliente HTTP JavaScript

O padrão do cliente HTTP JavaScript é um dos vários padrões que podem ser usados para criar mashups do lado do servidor com o Apigee Edge. Com o modelo de objetos JavaScript da Apigee, é possível 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 da política

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

No centro do padrão de composição da política está a política ServiceCallout. Essa política atua como um cliente HTTP para a API ou o serviço de back-end. No entanto, para ser completamente funcional, uma Service callout depende de outras políticas e permite 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 que é enviada pela ServiceFrase de destaque e para analisar o conteúdo na mensagem de resposta da API ou do serviço remoto.

O exemplo do livro de receitas de composição de políticas usa três políticas: AssignMessage, ServiceCallout e ExtractVariables. Essas políticas encapsulam as mensagens de request que você quer enviar ao back-end, o client que encaminha a mensagem para o back-end e um analisador de mensagens que analisa a resposta de cada API e atribui variáveis para os 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 breve resumo dessas três políticas:

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

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