Ajouter des fonctionnalités à l'aide de règles

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

Consultez la documentation d'Apigee Edge.

Apigee vous permet de programmer 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. 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é. Vous n'êtes pas limité à l'ensemble de types de règles fourni par Apigee. Vous pouvez également écrire des scripts et du code personnalisés (tels que des applications JavaScript) qui étendent les fonctionnalités du proxy d'API et vous permettent d'innover en plus des fonctionnalités de gestion de base compatibles avec les règles Apigee.

Créer et associer des règles à des proxys d'API et à des flux partagés à l'aide d'Apigee dans Cloud Code comme décrit dans les sections suivantes. Selon le type de stratégie, vous devrez peut-être créer une ressource, comme décrit dans la section Gérer les ressources. Voir aussi Gérer les dossiers et les fichiers dans un espace de travail Apigee.

Créer une règle

Pour créer une règle à l'aide d'Apigee dans Cloud Code, procédez comme suit :

Dans la section Apigee, effectuez l'une des actions suivantes en fonction de l'emplacement auquel vous souhaitez associer la stratégie :

Associer à	Action
proxy d'API	Effectuez l'une des actions suivantes : Placez le curseur sur l'un des dossiers suivants, cliquez sur , puis sélectionnez Create policy (Créer une règle) : Groupe de proxys `apiproxy-name` `apiproxy-name/apiproxy` Placez le curseur sur le dossier `apiproxy-name/apiproxy/policies` du proxy d'API, puis cliquez sur .
Flux partagés	Effectuez l'une des actions suivantes : Placez le curseur sur l'un des dossiers suivants, cliquez sur , puis sélectionnez Create policy (Créer une règle) : Groupe de flux partagé `sharedflow-name` `sharedflow-name/sharedflowbundle` Placez le curseur sur le dossier `sharedflow-name/sharedflowbundle/policies` du flux partagé, puis cliquez sur .

L'assistant de création de règle s'ouvre.

Sélectionnez la catégorie de la règle que vous souhaitez créer dans la liste. Pour obtenir la description des catégories de règles, consultez la page Présentation de la documentation de référence des règles.
Saisissez un nom unique pour la règle, puis appuyez sur Entrée. La règle est ajoutée au dossier /policies pour le proxy d'API ou le flux partagé dans la section Apigee, et ouverte dans l'éditeur.
Modifiez le fichier selon vos besoins, puis sélectionnez Fichier > Enregistrer ou ⌘S pour enregistrer vos modifications. Pour en savoir plus sur la configuration de la règle, consultez la page Présentation de la documentation de référence des règles.
Créez des ressources si nécessaire pour le type de stratégie, comme décrit dans la section Gérer les ressources.

Associer une règle à un flux

Les stratégies ne sont pas exécutées tant qu'elles ne sont pas associées à un flux. Vous pouvez associer une stratégie à un flux en ajoutant l'élément <Step> à l'élément de flux de requête ou de réponse approprié dans une configuration ProxyEndpoint ou TargetEndpoint, comme décrit dans les rubriques suivantes :

Par exemple, la configuration suivante associe un QuotaPolicy (règle de quota) à <PreFlow> de ProxyEndpoint pour configurer le nombre de messages de demande autorisés par un proxy d'API sur une période donnée.

<ProxyEndpoint name="default">
  <PreFlow>
    <Request>
      <Step><Name>QuotaPolicy</Name></Step>
    </Request>
  </PreFlow>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
  </HTTPProxyConnection>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>