Règle PythonScript

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Quoi

La stratégie de script Python vous permet d'ajouter une fonctionnalité Python personnalisée à votre flux de proxy d'API, en particulier lorsque la fonctionnalité dont vous avez besoin dépasse les règles prêtes à l'emploi de Edge que vous fournissez.

La compatibilité avec le langage Python est fournie via Jython version 2.5.2. Les bibliothèques tierces que vous ajoutez doivent être en "Python pur" (mises en œuvre uniquement en Python). Pour en savoir plus sur l'ajout de bibliothèques, consultez la section Fichiers de ressources.

Une règle Python ne contient aucun code réel. À la place, une règle Python référence une ressource Python et définit l'étape du flux d'API où le script Python s'exécute. Vous pouvez importer votre script via l'éditeur de proxy de l'interface utilisateur de gestion, ou vous pouvez l'inclure dans le /resources/py des proxys d'API que vous développez localement.

Exemples

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
        <DisplayName>Python-1</DisplayName>
        <ResourceURL>py://myscript.py</ResourceURL>
</Script>

import base64

username = flow.getVariable("request.formparam.client_id")
password = flow.getVariable("request.formparam.client_secret")

base64string = base64.encodestring('%s:%s' % (username, password))[:-1]
authorization = "Basic "+base64string

flow.setVariable("authorizationParam",authorization)

Documentation de référence des éléments

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
    <DisplayName>Python-1</DisplayName>
    <ResourceURL>py://myscript.py</ResourceURL>
    <IncludeURL>py://myscript_dependency.py</IncludeURL>
</Script>

Le tableau suivant décrit les attributs communs à tous les éléments parents des règles :

Élément <DisplayName>

Utilisez-le, en plus de l'attribut name, pour appliquer un libellé à la règle dans l'éditeur de proxys de l'interface de gestion en utilisant un nom différent, en langage naturel.

<DisplayName>Policy Display Name</DisplayName>

Élément <ResourceURL>

Cet élément spécifie le fichier Python principal qui sera exécuté dans le flux d'API. Vous pouvez stocker ce fichier au niveau du proxy d'API (sous /apiproxy/resources/py dans le groupe de proxys d'API ou dans la section Scripts du volet de navigation de l'éditeur de proxy d'API), ou aux niveaux de l'organisation ou de l'environnement afin de le réutiliser sur plusieurs proxys d'API, comme décrit dans la section Fichiers de ressources. Votre code peut utiliser les objets, les méthodes et les propriétés du modèle d'objet JavaScript.

<ResourceURL>py://myscript.py</ResourceURL>

Élément <IncludeURL>

Spécifie un fichier Python à charger en tant que dépendance au fichier Python principal spécifié avec l'élément <ResourceURL>. Les scripts seront évalués dans l'ordre dans lequel ils sont répertoriés dans la règle.

Incluez plusieurs ressources de dépendance Python avec des éléments <IncludeURL> supplémentaires.

<IncludeURL>py://myscript_dependency.py</IncludeURL>

Codes d'erreur

Cette section décrit les codes d'erreur et les messages d'erreur renvoyés ainsi que les variables d'erreur qui sont définis par Edge lorsque cette règle déclenche une erreur. Ces informations sont importantes si vous développez des règles de défaillance afin de gérer les pannes. Pour en savoir plus, consultez les pages Ce que vous devez savoir à propos des erreurs liées aux règles et Gérer les pannes.

Erreurs d'exécution

Ces erreurs peuvent se produire lors de l'exécution de la règle.

Erreurs de déploiement

Ces erreurs peuvent se produire lorsque vous déployez un proxy contenant cette règle.

Variables de panne

Ces variables sont définies lorsque cette règle déclenche une erreur au moment de l'exécution. Pour en savoir plus, consultez la section Ce que vous devez savoir sur les erreurs liées aux règles.

Exemple de réponse d'erreur

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Pythonscript runtime error: "ReferenceError: "status" is not defined.\"",
    "detail": {
      "errorcode": "steps.script.ScriptExecutionFailed"
    }
  }
}

Exemple de règle de défaillance

<FaultRule name="PythonScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(pythonscript.PythonScript-1.failed = true) </Condition>
</FaultRule>

Articles associés