Présentation de la documentation de référence des règles

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

Consultez la documentation d'Apigee Edge.

Les règles Apigee vous permettent de contrôler le trafic, d'améliorer les performances, d'appliquer la sécurité et d'améliorer la pertinence de vos API sans avoir à écrire de code ni à modifier les services de backend.

De plus, Apigee fournit des règles d'extension qui vous permettent de mettre en œuvre une logique personnalisée sous la forme de feuilles de style JavaScript, Python, Java et XSLT.

Catégories et types de règles

La catégorie d'une règle indique la zone fonctionnelle (la sécurité ou la médiation, par exemple) de la règle. Les règles sont affichées par ordre de catégorie ci-dessous.

Les types de règles s'appliquent aux utilisateurs du paiement à l'usage et aux utilisateurs ayant souscrit un abonnement 2024. Les utilisateurs abonnés aux forfaits Abonnement 2021 ne verront pas les distinctions de type de règle dans l'interface utilisateur d'Apigee et peuvent utiliser des règles indépendantes du type de règle.

Le type de règle fait référence à la manière dont elle peut être utilisée dans Apigee :

• Les règles standards conviennent aux développements internes et aux solutions d'API légères. Les règles standards peuvent être utilisées avec n'importe quel type d'environnement. Pour afficher la liste des règles standards, consultez la page Règles standards par catégorie.
• Les règles extensibles offrent plus de fonctionnalités que les règles standards, y compris pour la gestion du trafic, la médiation et la sécurité. Les règles extensibles incluent également des règles de mise en œuvre d'une logique personnalisée sous la forme de feuilles de style JavaScript, Python, Java et XSLT.
  
  Les règles extensibles ne peuvent être utilisées qu'avec des types d'environnement intermédiaires et complets. L'utilisation d'une règle extensible convertit automatiquement ce proxy en Proxy Extensible, ce qui peut avoir un coût et d'autres conséquences. Consultez les droits de paiement à l'usage et l'abonnement 2024 pour en savoir plus.
  
  Pour afficher la liste des règles extensibles, consultez la section Règles extensibles par catégorie.

Pour les utilisateurs de paiement à l'usage, les types de règles que vous pouvez utiliser dans un proxy dépendent des types d'environnement sur lequel vous envisagez de déployer ce proxy. Pour en savoir plus, consultez la section paiement à l'usage.

S'il existe deux règles, l'une standard et l'autre extensible, qui exécutent toutes deux les fonctions dont vous avez besoin, utilisez la règle standard.

Règles standards par catégorie

Voici les catégories des règles standards :

Règles de gestion du trafic	Règles de médiation	Règles de sécurité	Règles des extensions
Vous permet de contrôler les quotas et de limiter les effets des pics de trafic des API. Règle SpikeArrest	Vous permet de transformer, d'analyser et de valider les messages, ainsi que de générer des erreurs et des alertes. Règle CORS Règle GraphQL Règle HTTPModifier Règle JSONtoXML Règle OASValidation Règle PublishMessage Règle RaiseFault Règle ReadPropertySet Règle SOAPMessageValidation Règle XMLtoJSON	Vous permet d'appliquer des règles de sécurité. Règle AccessControl Règle HMAC Règles JWT : Règle DecodeJWT Règle VerifyJWT	Vous permet de définir des fonctionnalités de stratégie personnalisées, telles que des appels de services et la collecte de données de messages. Règle AssertCondition Règle ExternalCallout

Règles extensibles par catégorie

Vous trouverez ci-dessous les règles extensibles, par catégorie. Les proxys avec des règles extensibles ne peuvent être déployés que dans des environnements intermédiaires et complets. Les règles extensibles sont indiquées dans l'interface utilisateur avec l'icône : .

Règles de gestion du trafic	Règles de médiation	Règles de sécurité	Règles des extensions
vous permet de configurer la mise en cache, de contrôler les quotas, de limiter les effets des pics et d'effectuer d'autres fonctions liées au trafic de votre API. Règles de mise en cache : Règle InvalidateCache Règle LookupCache Règle PopulateCache Règle ResponseCache Règles relatives aux quotas Règle ResetQuota	Vous permet de transformer, d'analyser et de valider les messages, ainsi que de générer des erreurs et des alertes. Règle AccessEntity Règle AssignMessage Règle ExtractVariables Règle KeyValueMapOperations Règle MonétisationLimitsCheck Règle ParseDialogflowRequest Règle SetDialogflowResponse Règle XSLTransform	Vous permet de contrôler l'accès à vos API avec OAuth, à la validation des clés d'API et à d'autres fonctionnalités de protection contre les menaces. Règle BasicAuthentication Règle JSONThreatProtection Règles JWS : Règle DecodeJWS Règle GenerateJWS Règle VerifyJWS Règles JWT : Règle GenerateJWT Règles OAuth v2 : Règle DeleteOAuthv2Info Règle GetOAuthv2Info Règle OAuthv2 Règle RevokeOAuthv2 Règle SetOAuth v2 Info Règle RegularExpressionProtection Règle SAMLAssertion Règle de vérification des clés API Règle XMLThreatProtection	Vous permet de définir des fonctionnalités de stratégie personnalisées, telles que des appels de services, la collecte de données de messages et des appels Java, JavaScript et Python. Règle DataCapture Règle FlowCallout Règle IntegrationCallout Règle JavaCallout Règle JavaScript Règle MessageLogging Règle PythonScript Règle ServiceCallout Règle SetIntegrationRequest Règle TraceCapture