Política PythonScript

Esta é a documentação do Apigee Edge.
Acesse Documentação da Apigee X.
informações

O que

A política de scripts de Python permite que você adicione funcionalidades personalizadas do Python ao seu fluxo de proxy de API, especialmente quando a funcionalidade de que você precisa está além das políticas prontas do Edge que oferecem.

O suporte à linguagem Python é fornecido pelo Jython versão 2.5.2. As bibliotecas de terceiros adicionadas precisam ser "Python puro" (implementadas apenas em Python). Para mais informações sobre como adicionar bibliotecas, consulte Arquivos de recursos.

Uma política do Python não contém um código real. Em vez disso, uma política do Python faz referência a um recurso do Python e define a etapa no fluxo da API em que o script do Python é executado. Você pode enviar seu script por meio do editor de proxy da interface de gerenciamento ou você pode incluí-lo no /resources/py em proxies de API que você desenvolve localmente.

Amostras

Política e script do Python

Política de script do Python

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

Neste exemplo, o elemento ResourceURL especifica o recurso de script Python relevante.

Script do Python

Mostra o que você pode incluir no próprio script Python.

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)

Referência de 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>

A tabela a seguir descreve atributos comuns a todos os elementos pai de políticas:

Atributo Descrição Padrão Presença
name

O nome interno da política. O valor do atributo name pode conter letras, números, espaços, hifens, sublinhados e pontos. Esse valor não pode exceder 255 caracteres.

Opcionalmente, use o elemento <DisplayName> para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.

N/A Obrigatório
continueOnError

Defina como false para retornar um erro quando uma política falhar. Esse é o comportamento esperado na maioria das políticas.

Defina como true para que a execução do fluxo continue, mesmo depois que uma política falhar.

falso Opcional
enabled

Defina como true para aplicar a política.

Defina como false para desativar a política. A política não será aplicada mesmo se ela permanecer anexada a um fluxo.

true Opcional
async

Esse atributo está obsoleto.

falso Obsoleto

Elemento <DisplayName>

Use em conjunto com o atributo name para rotular a política no editor de proxy da IU de gerenciamento com um nome de linguagem natural diferente.

<DisplayName>Policy Display Name</DisplayName>
Padrão

N/A

Se você omitir esse elemento, será usado o valor do atributo name da política.

Presença Opcional
Tipo String

<ResourceURL> element

Esse elemento especifica o arquivo principal do Python que será executado no fluxo da API. É possível armazenar esse arquivo no escopo do proxy da API (em /apiproxy/resources/py no pacote do proxy da API ou na seção "Scripts" do painel de navegação do editor de proxy da API) ou no escopo da organização ou do ambiente para reutilização em vários proxies de API, conforme descrito em Arquivos de recurso. O código pode usar os objetos, métodos e propriedades do modelo de objeto JavaScript.

<ResourceURL>py://myscript.py</ResourceURL>
Padrão: Nenhum
Presença: Obrigatório
Tipo: String

Elemento <IncludeURL>

Especifica um arquivo Python que será carregado como dependência ao arquivo principal do Python especificado com o elemento <ResourceURL>. Os scripts serão avaliados na ordem em que estão listados na política.

Inclua mais de um recurso de dependência do Python com elementos <IncludeURL> adicionais.

<IncludeURL>py://myscript_dependency.py</IncludeURL>
Padrão: Nenhum
Presença: Opcional
Tipo: String

Códigos de erro

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.

Fault code HTTP status Cause Fix
steps.script.ScriptEvaluationFailed 500 The PythonScript policy can throw several different types of ScriptExecutionFailed errors. Commonly seen types of errors include NameError and ZeroDivisionError.

Deployment errors

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

Error name Cause Fix
InvalidResourceUrlFormat If the format of the resource URL specified within the <ResourceURL> or the <IncludeURL> element of the PythonScript policy is invalid, then the deployment of the API proxy fails.
InvalidResourceUrlReference If the <ResourceURL> or the <IncludeURL> elements refer to a PythonScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.

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.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. pythonscript.PythonScript-1.failed = true

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>

Temas relacionados