Comprendre les API et les proxys d'API

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Apigee Edge vous permet de créer facilement et rapidement des API RESTful pouvant être utilisées par les développeurs d'applications. Vous exposez des API sur Edge 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 Edge.

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

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

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

Vous exposez les API sur Apigee Edge 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 illustré 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.

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 de gestion Edge 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, ainsi que tout autre fichier secondaire, qui définissent votre proxy d'API, puis les importer dans Edge.
  • Utilisation de l'API de gestion Edge pour créer vos proxys d'API en envoyant une série de requêtes REST à Edge.
  • Déployez une application Node.js en tant que proxy. Consultez la section Déployer une application Node.js autonome.

Qu'est-ce qu'une stratégie ?

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

Un excellent moyen d'en savoir plus sur les proxys d'API consiste à utiliser les exemples, comme décrit dans Utiliser les exemples de proxys d'API.

En savoir plus