Comprendre les API et les proxys d'API

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Apigee vous permet de créer facilement et rapidement des API RESTful qui peuvent être utilisées par les développeurs d'applications. Vous exposez les API sur Apigee en créant des proxys d'API qui agissent comme des "façades" gérées pour les services de backend. Cette rubrique traite de la relation entre les API et les proxys d'API sur Apigee.

Vidéo : Regardez cette courte vidéo pour une présentation des proxys d'API.

Qu'est-ce qu'une API ?

Une API est une interface qui permet à une application de consommer facilement les fonctionnalités ou les données d'une autre application. En définissant des points d'entrée stables et simplifiés sur la logique et les données des applications, les API permettent aux développeurs d'accéder facilement à la logique d'application créée par d'autres développeurs et de la réutiliser. Dans le cas des API Web, cette logique et ces données sont exposées sur le réseau.

Étant donné que les applications qui consomment des API sont sensibles aux modifications, les API impliquent également un contrat. Le contrat fournit un certain niveau de garantie, selon lequel l'API évolue de manière prévisible au fil du temps.

Apigee vous permet de créer des API et, si vous avez déjà des API, de les exposer directement, tout en ajoutant une couche de gestion et de visibilité. Si vous avez des services compatibles avec HTTP, tels que les services Web basés sur SOA, ils peuvent également être exposés en tant qu'API via Apigee.

Apigee vous permet également de créer des API en mettant en œuvre des applications hébergées sur la plate-forme de services d'API, sans service de backend impliqué. Vous pouvez créer ces applications en JavaScript et en Java.

Qu'est-ce qu'un proxy d'API ?

Vous exposez des API sur Apigee en mettant en œuvre des proxys d'API. Grâce aux proxys d'API, les API liées aux applications sont dissociées des services de backend, ce qui permet de protéger ces applications si le code de backend est modifié. Lorsque vous apportez des modifications de backend à vos services, les applications continuent à appeler les mêmes API et ne subissent pas d'interruption.

Dans une configuration de proxy d'API, il existe deux types de points de terminaison :

ProxyEndpoint : définit la manière dont les applications clientes consomment vos API. Vous configurez ProxyEndpoint pour définir l'URL de votre proxy d'API. Le point de terminaison du proxy détermine également si les applications accèdent au proxy d'API via HTTP ou HTTPS. Vous devez généralement associer des règles au ProxyEndpoint pour la sécurité, les contrôles de quota et d'autres types de contrôle d'accès et de limitation du débit.
TargetEndpoint : définit la manière dont le proxy d'API interagit avec vos services de backend. Vous devez configurer le TargetEndpoint pour transférer les requêtes vers le service de backend approprié, y compris définir les paramètres de sécurité, le protocole HTTP ou HTTPS et d'autres informations de connexion. Vous pouvez associer des règles au TargetEndpoint pour vous assurer que les messages de réponse sont correctement formatés pour l'application qui a effectué la requête initiale.

Vous pouvez visualiser les proxys d'API comme indiqué dans le graphique ci-dessous :

Les requêtes HTTP passent par le point de terminaison de la requête du proxy, sont transmises au point de terminaison de la requête cible, puis envoyées aux services de backend. Les réponses HTTP passent par le point de terminaison de la réponse cible, sont transmises au point de terminaison de la réponse du proxy, puis renvoyées au client.

Types de proxys d'API

Les types de proxys d'API s'appliquent aux forfaits Paiement à l'usage et Abonnement 2024. Les utilisateurs disposant d'un forfait Abonnement 2021 ne verront pas les types de proxy d'API dans l'interface utilisateur Apigee et n'ont pas besoin de connaître les types de proxy d'API.

Apigee est compatible avec deux types de proxy :

Les proxys standards n'incluent que les règles standards. Les proxys standards conviennent aux solutions d'API légères et ne peuvent pas être inclus dans les produits d'API.
Les proxys extensibles incluent au moins une règle étendue ou un hook de flux. Les proxys extensibles peuvent inclure beaucoup plus de fonctionnalités que les proxys standards.

Comment créer un proxy d'API ?

Un proxy d'API consiste en un ensemble de fichiers de configuration XML et de code (tels que JavaScript et Java). Apigee propose plusieurs méthodes pour créer des proxys d'API, y compris :

Utiliser l'interface utilisateur Apigee pour définir un proxy d'API dans une interface utilisateur graphique (IUG). Pour en savoir plus, consultez la section Créer un proxy d'API simple.
Créer des fichiers XML et d'autres fichiers sources qui définissent votre proxy d'API, puis les importer dans Apigee.
Utiliser l'API Apigee pour créer des proxys d'API en effectuant une série de requêtes REST vers Apigee.
Développez en local à l'aide d'Apigee dans VS Code et déployez en tant qu'archive. Pour en savoir plus, consultez la page Présentation du développement local avec Apigee.

Qu'est-ce qu'une révision de proxy d'API ?

Les révisions de proxy d'API fournissent un mécanisme léger pour gérer les mises à jour de la configuration de proxy d'API lorsque vous effectuez des itérations. Les révisions sont numérotées de manière séquentielle, ce qui vous permet d'annuler une modification en déployant une révision précédente de votre proxy d'API. Les révisions vous permettent de déployer un proxy d'API dans un environnement de production tout en continuant à créer des révisions de ce proxy d'API dans un environnement de test. Lorsque vous êtes prêt, vous pouvez promouvoir la révision supérieure du proxy de l'API, de test à production.

Qu'est-ce qu'une règle ?

Apigee vous permet de contrôler le comportement de l'API sans écrire de code à l'aide de règles. Une règle est comme un module qui met en œuvre une fonction de gestion limitée et spécifique dans le flux de requête/réponse du proxy. Les règles vous permettent d'ajouter des types courants de fonctionnalités de gestion à une API de manière simple et fiable. Les règles fournissent des fonctionnalités telles que la sécurité, la limitation du débit, la transformation et la médiation, ce qui vous évite d'avoir à coder et à gérer vous-même cette fonctionnalité.

Créer votre premier proxy d'API

Apigee fournit un ensemble de tutoriels que vous pouvez utiliser pour créer votre première API. Commencez par Créer votre premier proxy d'API. Consultez également autres Rubriques Premiers pas.