Cette page s'applique à Apigee et à Apigee hybrid.
Consultez la documentation d'
Apigee Edge.
Cet article répertorie certaines caractéristiques de base des proxys d'API, ainsi que des liens vers des informations supplémentaires.
Les API sont des points d'entrée permettant à une application d'utiliser les fonctionnalités d'une autre application. Vous mettez en œuvre des proxys d'API pour créer des API
Dans Apigee, vous mettez en œuvre des proxys d'API en configurant une logique de proxy d'API sous la forme d'une séquence d'étapes qui s'exécutent en réponse à une requête du code client. Pour exposer un proxy d'API à des clients, vous devez définir des points de terminaison qui incluent une URL avec des chemins de ressources, un verbe HTTP, des exigences spécifiques au corps, etc.
Bien que la terminologie parle de "proxy d'API", du point de vue du code client, il s'agit de l'API.
Pour obtenir une présentation des proxys d'API, consultez la page Comprendre les API et les proxys d'API.
Vous organisez la séquence de la logique de proxy d'API à l'aide de flux.
Dans une application, les données passent par l'application et sont guidées par une logique de condition. Dans Apigee, le chemin de traitement est constitué de flux. Un flux est une séquence d'étapes (ou "pas") qui constituent le chemin de traitement d'un proxy d'API. Les flux correspondent à la manière dont Apigee vous permet d'appliquer la logique et le comportement à des emplacements spécifiques du client vers la ressource backend, pour ensuite revenir au client.
Pour en savoir plus sur les flux, consultez la section Contrôler l'exécution d'un proxy avec des flux.
Vous accédez aux données d'état via des variables de flux créées par les proxys d'API.
Un proxy d'API a accès à des variables qui représentent l'état d'exécution. Vous pouvez accéder à ces variables à partir du fichier XML qui configure vos proxys et vos règles d'API. Vous pouvez également y accéder lorsque vous développez une extension d'un proxy d'API à l'aide d'un langage procédural, tel que Java, JavaScript ou Python.
Ces variables sont conservées par Apigee. Certains existent par défaut, généralement parce qu'il s'agit de variables communes aux actions réalisées par les proxys d'API (par exemple, parce qu'elles font partie d'une requête HTTP). Vous pouvez également créer vos propres variables pour répondre à une exigence logique.
Pour en savoir plus sur les variables, consultez la page Gérer l'état du proxy avec des variables de flux.
Vous pouvez exécuter les proxys d'API de manière conditionnelle
Comme avec la plupart des langages de programmation, le code figurant dans les proxys d'API peut être exécuté de manière conditionnelle. Les conditions sont souvent basées sur l'état du proxy d'API, auquel vous pouvez accéder via des variables de flux. Par exemple, vous pouvez avoir une condition qui vérifie l'élément user-agent, puis traite la requête en conséquence.
Pour en savoir plus sur l'exécution conditionnelle, consultez la page Conditions avec variables de flux.
Vous mettez en œuvre la plupart des logiques dans un proxy d'API à l'aide de stratégies.
La plupart des logiques que vous ajoutez à un proxy d'API sont empaquetées sous forme de stratégies. Une stratégie est un composant Apigee qui encapsule la logique d'une zone fonctionnelle, telle que la gestion de la sécurité ou du trafic. Vous configurez une stratégie avec XML qui définit les propriétés de la logique sous-jacente. Vous organisez les stratégies dans une séquence de "pas" au sein d'un flux, de sorte que votre proxy d'API exécute la logique dans l'ordre le mieux adapté aux objectifs de votre proxy.
Pour en savoir plus sur les règles, consultez l'article Qu'est-ce qu'une règle ?.
Vous pouvez inclure des ensembles de fonctionnalités réutilisables.
Lorsque votre proxy d'API inclut une logique qui sera utilisée à différents emplacements dans votre code (par exemple, d'autres proxys d'API), vous pouvez collecter cette logique pour les appels en provenance de plusieurs emplacements. Par exemple, vous pouvez regrouper la logique de sécurité au sein d'un flux partagé appelé par d'autres proxys d'API, ce qui réduit la duplication à travers l'ensemble les proxys d'API.
Remarque : Pour en savoir plus sur les flux partagés, consultez la section Flux partagés réutilisables. Pour en savoir plus sur le chaînage de proxy d'API, consultez la section Chaîner des proxys d'API.
Vous pouvez déboguer un proxy avec l'outil Debug
Apigee inclut un outil Debug qui vous permet d'examiner le flux d'exécution du proxy d'API lors du débogage et des tests. L'outil présente de manière visuelle chaque étape du proxy d'API qui s'exécute dans le cadre d'une requête. Comme dans un débogueur classique, vous pouvez afficher pour chaque étape la liste des valeurs de variables qui composent l'état du proxy d'API.
Pour en savoir plus sur le débogage avec l'outil Debug, consultez la page Outil Debug.
Vous traitez les erreurs de proxy d'API comme des pannes.
En configurant un gestionnaire de pannes, vous pouvez personnaliser l'erreur renvoyée à un client API. Les gestionnaires de pannes vous permettent de contrôler les messages d'erreur, que l'erreur provienne de votre propre code ou qu'elle provienne d'un composant inclus (comme une stratégie).
Pour en savoir plus, consultez la page Gérer les erreurs.