Partilhar via

Adicionar a colocação em cache para melhorar o desempenho na Gestão de API do Azure

APLICA-SE A: Developer | Básico | Básico v2 | Padrão | Padrão v2 | Prémio | Premium v2 | Isolado

APIs e operações no Gerenciamento de API podem ser configuradas com cache de resposta. A colocação em cache de respostas pode reduzir significativamente a latência dos autores de chamadas à API e a carga de back-end dos fornecedores de API. Este artigo descreve como adicionar cache às suas APIs.

Importante

O cache interno é volátil e é compartilhado por todas as unidades na mesma região na mesma instância de Gerenciamento de API. Independentemente do tipo de cache usado (interno ou externo), se as operações relacionadas ao cache não conseguirem se conectar ao cache devido à volatilidade do cache ou por qualquer outro motivo, a chamada de API que usa a operação relacionada ao cache não gerará um erro e a operação de cache será concluída com êxito. No caso de uma operação de leitura, será devolvido um valor nulo à expressão de política de chamada. Seu código de política deve ser projetado para garantir que haja um mecanismo de fallback para recuperar dados que não foram encontrados no cache.

Para obter informações mais detalhadas sobre a colocação em cache, veja Colocação em cache das políticas de Gestão de API e Colocação em cache personalizada na Gestão de API do Azure.

Captura de tela que mostra as políticas de cache no Gerenciamento de API.

Neste artigo você:

  • adicionar a colocação em cache de resposta para a API
  • Verifique se o cache está funcionando

Nota

O cache interno não está disponível na camada Consumo do Gerenciamento de API do Azure. Em vez disso, você pode usar um Cache Redis do Azure externo. Você também pode configurar um cache externo em outras camadas de serviço de Gerenciamento de API.

Pré-requisitos

Adicionar políticas de cache

Com as políticas de cache mostradas neste exemplo, a primeira solicitação para uma operação de teste retorna uma resposta do serviço de back-end. Esta resposta é colocada em cache, codificada pelos cabeçalhos e pelos parâmetros de cadeia de consulta especificados. As chamadas subsequentes para a operação, com parâmetros correspondentes, retornarão a resposta armazenada em cache até que o intervalo de duração do cache expire.

  1. Inicie sessão no portal do Azure.

  2. Vá para sua instância de Gerenciamento de API.

  3. Selecione APIs> APIs no menu à esquerda.

  4. Selecione uma API para a qual você deseja configurar o cache.

  5. Na parte superior do ecrã, selecione o separador Estrutura .

  6. Na seção Processamento de entrada , selecione o <ícone /> :

    Captura de ecrã que mostra APIs de Gestão de API no portal.

  7. No elemento , adicione a inbound seguinte política:

    <cache-lookup vary-by-developer="false" vary-by-developer-groups="false">
    <vary-by-header>Accept</vary-by-header>
    <vary-by-header>Accept-Charset</vary-by-header>
    <vary-by-header>Authorization</vary-by-header>
</cache-lookup>

  8. No elemento , adicione a outbound seguinte política:

    <cache-store duration="20" />

    Nesta política, duration especifica o intervalo de expiração das respostas armazenadas em cache. O intervalo é de 20 segundos.

  9. Selecione Guardar.

Gorjeta

Se você estiver usando um cache externo, conforme descrito em Usar um Cache Redis do Azure externo no Gerenciamento de API do Azure, convém especificar o caching-type atributo das políticas de cache. Consulte Políticas de cache do Gerenciamento de API para obter mais informações.

Chamar uma operação para testar o cache

Para testar a cache, execute uma operação no portal.

  1. No portal do Azure, vá para sua instância de Gerenciamento de API.
  2. Selecione APIs> APIs no menu à esquerda.
  3. Selecione a API à qual adicionou as políticas de colocação em cache.
  4. Selecione uma operação para testar.
  5. Selecione a guia Teste na parte superior da janela.
  6. Selecione Rastrear duas ou três vezes em rápida sucessão.
  7. Em Resposta HTTP, selecione a guia Rastreamento .
  8. Vá para a seção Entrada e role até a cache-lookup política. Você verá uma mensagem semelhante à da captura de ecrã a seguir, que indica um acerto de cache: Captura de ecrã da consulta de cache ao testar uma API no portal.

Conteúdos relacionados