Norme relative a PythonScript

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Cosa

Il criterio dello script Python ti consente di aggiungere funzionalità Python personalizzate al flusso del proxy API, soprattutto quando le funzionalità di cui hai bisogno vanno oltre i criteri predefiniti di Edge che forniscono.

Il supporto del linguaggio Python è fornito tramite Jython versione 2.5.2. Le librerie di terze parti che aggiungi devono essere "Python puro" (implementato solo in Python). Per ulteriori informazioni sull'aggiunta di librerie, consulta File di risorse.

Un criterio Python non contiene codice effettivo. Un criterio Python fa riferimento invece a un file Python risorsa e definisce il passaggio nel flusso dell'API in cui viene eseguito lo script Python. Puoi caricare lo script tramite l'editor proxy dell'interfaccia utente di gestione oppure puoi includerlo nella Directory /resources/py nei proxy API che sviluppi localmente.

Esempi

<?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)

Riferimento elemento

<?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>

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali del criterio:

<DisplayName> elemento

Da utilizzare in aggiunta all'attributo name per etichettare il criterio in editor proxy della UI di gestione con un nome diverso e in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

<ResourceURL> elemento

Questo elemento specifica il file Python principale che verrà eseguito nel flusso dell'API. Puoi archiviare questo file nell'ambito del proxy API (in /apiproxy/resources/py nel proxy API o nella sezione Script del riquadro di navigazione dell'editor del proxy API) o nella a livello di organizzazione o di ambiente per il riutilizzo in più proxy API, come descritto in File di risorse: Il tuo codice può utilizzare oggetti, metodi e proprietà del modello a oggetti JavaScript.

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

<IncludeURL> elemento

Specifica un file Python da caricare come dipendenza dal file Python principale specificato con Elemento <ResourceURL>. Gli script verranno valutati nell'ordine in cui sono elencate nelle norme.

Includi più di una risorsa di dipendenza Python con <IncludeURL> elementi.

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

Codici di errore

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>

Argomenti correlati