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

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.

Importante

O cache interno é volátil e compartilhado por todas as unidades na mesma região no mesmo serviço de Gerenciamento de API. Independentemente do tipo de cache que está a ser utilizado (interno ou externo), se as operações relacionadas com a cache não ligarem à cache devido à volatilidade da cache ou a qualquer outro motivo, a chamada à API que utiliza a operação relacionada com a cache não gerará nenhum 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 não 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.

políticas de cache

O que irá aprender:

  • adicionar a colocação em cache de resposta para a API
  • verificar a colocação em cache em ação

Nota

O cache interno não está disponível na camada de 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

Para concluir este tutorial:

adicione as políticas de colocação em 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. Para as chamadas subsequentes à operação que tenham parâmetros correspondentes, será devolvida a resposta em cache, até que o intervalo de duração da cache expire.

  1. Inicie sessão no portal do Azure.

  2. Navegue até 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 Design.

  6. Na seção Processamento de entrada, selecione o <ícone /> . Captura de tela do editor de políticas de Gerenciamento 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, a duração especifica o intervalo de expiração das respostas armazenadas em cache. Neste exemplo, o intervalo restante é de 20 segundos.

Gorjeta

Se você estiver usando um cache externo, conforme descrito em Usar um Cache do Azure externo para Redis 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 detalhes.

Chamar uma operação e testar a colocação em cache

Para ver o cache em ação, chame uma operação do portal.

  1. No portal do Azure, navegue até 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 no menu superior direito.
  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 tela a seguir, indicando um acerto no cache: Captura de tela da pesquisa de cache ao testar uma API no portal.