Antimodèle : définir plusieurs points de terminaison proxy dans un proxy d'API

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

La configuration ProxyEndpoint définit la façon dont les applications clientes consomment les API via Apigee Edge. Le point de terminaison proxy définit l'URL du proxy d'API et le comportement d'un proxy : les règles à appliquer et les points de terminaison cibles vers lesquels acheminer, et les conditions à respecter pour ces règles ou règles de routage à exécuter.

En bref, la configuration de point de terminaison proxy définit tout ce qui doit être fait pour mettre en œuvre une API.

Antimodèle

Un proxy d'API peut avoir un ou plusieurs points de terminaison proxy. La définition de plusieurs points de terminaison proxy est un mécanisme simple et facile pour mettre en œuvre plusieurs API dans un seul proxy. Cela vous permet de réutiliser des règles et/ou une logique métier avant et après l'appel d'un point de terminaison cible.

D'autre part, lorsque vous définissez plusieurs ProxyEndpoints dans un seul proxy d'API, vous finissez par combiner conceptuellement de nombreuses API sans rapport entre elles en un seul artefact. Cela rend les proxys d'API plus difficiles à lire, comprendre, déboguer et gérer, ce qui va à l'encontre de la philosophie principale des proxys d'API : faciliter la création et la gestion des API pour les développeurs.

Impact

Plusieurs points de terminaison proxy dans un proxy d'API peuvent :

  • Rendre la compréhension et la gestion du proxy d'API par les développeurs difficiles.
  • Obscurcir les données d'analyse. Par défaut, les données d'analyse sont agrégées au niveau du proxy. Il n'y a aucune répartition des métriques par point de terminaison proxy, sauf si vous créez des rapports personnalisés.
  • Rendre la résolution des problèmes liés aux proxys d'API difficile.

Bonne pratique

Lorsque vous mettez en œuvre un nouveau proxy d'API ou modifiez un proxy d'API existant, suivez les bonnes pratiques suivantes :

  1. Mettez en œuvre un proxy d'API avec un seul point de terminaison proxy.
  2. Si plusieurs API partagent le même serveur cible et/ou nécessitent la même logique pré- ou post- appel du serveur cible, envisagez d'utiliser des flux partagés pour implémenter cette logique dans différents proxys d'API.
  3. Si plusieurs API partagent un chemin de base de départ commun, mais n'ont pas le même suffixe, utilisez des flux conditionnels dans un seul point de terminaison proxy.
  4. S'il existe un proxy d'API avec plusieurs points de terminaison proxy et qu'il n'y a pas de problème, il n'est pas nécessaire d'effectuer d'action.

L'utilisation d'un point de terminaison proxy par proxy d'API entraîne :

  1. Une gestion des proxys plus simple et plus facile.
  2. Les informations améliorées dans Analytics, telles que les performances du proxy et le temps de réponse cible, sont signalées séparément au lieu d'être regroupées pour tous les points de terminaison proxy.
  3. Un dépannage et une résolution des problèmes plus rapides.

Documentation complémentaire