Présentation des antimodèles

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

Cette section concerne les antimodèles courants observés dans le cadre des proxys d'API déployés sur la plate-forme Apigee Edge.

Heureusement, chacun de ces antimodèles peut être clairement identifié et corrigé avec les bonnes pratiques appropriées. Par conséquent, les API déployées sur Edge répondraient à leur objectif prévu et seraient plus performantes.

Résumé des antimodèles

Le tableau suivant répertorie les antimodèles dans cette section :

Catégorie	Antimodèles
Antimodèles de règles	Utiliser waitForComplete() dans le code JavaScript Définir un délai d'expiration long pour les jetons OAuth Utiliser des quantificateurs gourmands dans la règle RegularExpressionProtection Mettre les réponses d'erreur en cache Stocker les données supérieures à 512 ko dans le cache Consigner des données dans des serveurs tiers à l'aide de la règle JavaScript Utilisation d'une version JSONPath non conforme Appeler MessageLogging plusieurs fois dans un proxy d'API Configurer un quota non distribué Réutiliser une règle de quota Utiliser la règle RaiseFault dans des conditions inappropriées Accéder de façon incorrecte aux en-têtes HTTP à valeurs multiples dans un proxy d'API Utiliser la règle ServiceCallout pour appeler un service de backend sans proxy cible Utilisation de n'importe quelle règle OAuth V1, qui est obsolète. Consultez la section Abandons.
Antimodèles de performances	Laisser les proxys d'API NodeJS non utilisés déployés
Antimodèles génériques	Effectuer des appels d'API Management à partir d'un proxy d'API Appeler un proxy dans un proxy à l'aide d'un code personnalisé ou en tant que cible Gérez les ressources Edge sans utiliser la gestion du contrôle du code source Définir plusieurs hôtes virtuels avec le même alias d'hôte et le même numéro de port Équilibrer la charge avec un seul serveur cible tout en définissant MaxMaxFailures sur une valeur non nulle Accéder à la charge utile de requête/réponse lorsque le streaming est activé Définir plusieurs ProxyEndpoints dans un proxy d'API
Antimodèles de backends	Tolérer un backend lent Désactiver les connexions HTTP persistantes (keep-alive)
Antimodèles Edge pour Private Cloud	Ajouter des informations personnalisées au schéma appartenant à Apigee dans la base de données Postgres

Télécharger l'e-book sur les antimodèles

Outre les liens ci-dessus, vous pouvez également télécharger les antimodèles au format d'e-book :

• The Book of Apigee Edge Antipatterns v2.0 (PDF)

Qu'est-ce qu'un antimodèle ?

Wikipédia définit un antimodèle de logiciel comme suit :

format_quote

En ingénierie logicielle, un antimodèle est un modèle qui peut être couramment utilisé, mais qui est inefficace et/ou contre-productif dans la pratique.

format_quote

En termes simples, un antimodèle est quelque chose que le logiciel autorise l'utilisateur à faire, mais qui peut avoir un impact négatif sur les fonctionnalités, la maintenance ou les performances.

Prenons l'exemple de la classe "God Class/Object" aux accents de tout-puissance.

Dans le jargon orienté objet, une god class est une classe qui contrôle trop de classes pour une application donnée.

Prenons l'exemple d'une application comportant l'arborescence de référence suivante :

Comme le montre l'illustration, la god class utilise et référence trop de classes.

Le framework sur lequel l'application a été développée n'empêche pas la création de ce type de classe. Il présente toutefois de nombreux inconvénients, les principaux étant :

• Sa difficulté de gestion
• Son point de défaillance unique lorsque l'application s'exécute

Vous devez donc éviter de créer une telle classe. Il s'agit d'un antimodèle.

Audience cible

Cette section est particulièrement utile aux développeurs Apigee Edge lorsqu'ils progressent dans le cycle de vie de la conception et du développement des proxys d'API pour leurs services. Idéalement, elle doit être utilisée comme guide de référence pendant le cycle de développement des API et lors du dépannage.