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>

The following table describes attributes that are common to all policy parent elements:

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<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

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Example error response

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

Example fault rule

<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