Ajout de mise en cache pour améliorer les performances dans Gestion des API Azure

  • Article

S’APPLIQUE À : Développeur | Essentiel | Essentiel v2 | Standard | Standard v2 | Premium

Les API et opérations dans Gestion des API Azure peuvent être configurées pour mettre en cache la réponse. La mise en cache des réponses peut réduire considérablement la latence pour les appelants d’API et la charge backend pour les fournisseurs d’API.

Important

Le cache intégré est volatile et partagé par toutes les unités de la même région dans le même service de gestion des API. Quel que soit le type de cache utilisé (interne ou externe), si les opérations liées au cache ne parviennent pas à se connecter au cache en raison de la volatilité du cache ou de toute autre raison, l’appel d’API qui utilise l’opération liée au cache ne génère pas d’erreur et l’opération de cache se termine correctement. Dans le cas d’une opération de lecture, une valeur null est retournée à l’expression de stratégie appelante. Vous devez concevoir votre code de stratégie pour assurer qu’un mécanisme de « secours » permet de récupérer des données introuvables dans le cache. Pour plus d’informations sur la mise en cache, consultez Stratégies de mise en cache de Gestion des API et Mise en cache personnalisée dans Gestion des API Azure.

stratégies de cache

Ce que vous allez apprendre :

  • Ajouter une mise en cache des réponses pour votre API
  • Vérifier l’action de mise en cache

Remarque

Le cache interne n’est pas disponible dans le niveau Consommation de Gestion des API Azure. Vous pouvez utiliser un Cache Azure pour Redis externe à la place. Vous pouvez également configurer un cache externe dans d’autres niveaux de service de la gestion des API.

Prérequis

Pour suivre ce tutoriel :

Ajouter les stratégies de mise en cache

Avec les stratégies de mise en cache montrées dans cet exemple, la première requête envoyée à l’opération GetSpeakers renvoie une réponse du service principal. Cette réponse est mise en cache, du fait des en-têtes et des paramètres de chaîne de requête spécifiés. Les autres appels à l'opération comportant des paramètres correspondants recevront la réponse mise en cache, jusqu'à expiration de la durée de mise en cache.

  1. Connectez-vous au portail Azure.

  2. Accédez à votre instance APIM.

  3. Sélectionnez l’onglet API.

  4. Cliquez sur API de conférence de démonstration dans votre liste d’API.

  5. Sélectionnez GetSpeakers.

  6. Sélectionnez l’onglet Conception en haut de l’écran.

  7. Dans la section Traitement entrant, cliquez sur l’icône </>.

    éditeur de code

  8. Dans l’élément entrant, ajoutez la stratégie suivante :

    <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>

  9. Dans l’élément sortant, ajoutez la stratégie suivante :

    <cache-store duration="20" />

    Durée spécifie l'intervalle d'expiration des réponses mises en cache. Dans cet exemple, l’intervalle est de 20 secondes.

Conseil

Si vous utilisez un cache externe, comme décrit dans Utiliser un Cache Azure pour Redis externe dans Gestion des API Azure, vous souhaiterez peut-être spécifier l’attribut caching-type des stratégies de mise en cache. Consultez Stratégies de mise en cache de Gestion des API pour plus d’informations.

Appel d’une opération et test de la mise en cache

Pour voir la mise en cache en action, appelez l'opération depuis le portail des développeurs.

  1. Dans le portail Azure, accédez à votre instance APIM.
  2. Sélectionnez l’onglet API.
  3. Sélectionnez l’API à laquelle vous avez ajoutée des stratégies de mise en cache.
  4. Sélectionnez l’opération GetSpeakers.
  5. Cliquez sur l’onglet Test dans le menu supérieur droit.
  6. Appuyez sur Envoyer.

Étapes suivantes