Zasada PythonScript

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Co

Zasada dotycząca skryptu w języku Python umożliwia dodawanie dostosowanych funkcji Pythona do procesu serwera proxy interfejsu API, zwłaszcza wtedy, gdy potrzebne funkcje wykraczają poza gotowe zasady dotyczące Edge i udostępniania.

Obsługa języka Python jest świadczona przez Jython wersji 2.5.2. Dodawane przez Ciebie biblioteki innych firm muszą być „czystego Pythona” (zaimplementowane tylko w Pythonie). Więcej informacji o dodawaniu bibliotek znajdziesz w sekcji Pliki zasobów.

Zasada Pythona nie zawiera rzeczywistego kodu. Zamiast tego zasada Pythona odwołuje się do tego języka. i określa krok w przepływie interfejsu API, na którym wykonuje się skrypt Pythona. Możesz przesłać za pomocą edytora serwera proxy interfejsu zarządzania. Można też umieścić go w Katalog /resources/py na serwerach proxy interfejsu API, które tworzysz lokalnie.

Przykłady

Python – zasady pismo

Zasada skryptu Python

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

W tym przykładzie element ResourceURL określa odpowiedni skrypt Pythona .

Skrypt Pythona

Tutaj możesz zobaczyć, co można umieścić w skrypcie Pythona.

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)

Odwołanie do elementu

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

W tej tabeli opisano atrybuty wspólne dla wszystkich elementów nadrzędnych zasad:

Atrybut Opis Domyślny Obecność
name

Wewnętrzna nazwa zasady. Wartość atrybutu name może zawierać litery, cyfry, spacje, łączniki, podkreślenia i kropki. Ta wartość nie może przekracza 255 znaków.

Opcjonalnie możesz użyć elementu <DisplayName> do oznaczenia zasady jako edytor proxy interfejsu zarządzania z inną nazwą w języku naturalnym.

 Nie dotyczy Wymagane
continueOnError

Ustaw jako false, aby w przypadku niepowodzenia zasady zwracany był błąd. To normalne w przypadku większości zasad.

Ustaw jako true, aby wykonywanie przepływu było kontynuowane nawet po zastosowaniu zasady niepowodzenie.

 fałsz Opcjonalnie
enabled

Aby egzekwować zasadę, ustaw wartość true.

Aby wyłączyć zasadę, ustaw wartość false. Te zasady nie będą jest wymuszane nawet wtedy, gdy jest ono połączone z przepływem.

 prawda Opcjonalnie
async

Ten atrybut został wycofany.

 fałsz Wycofano

&lt;DisplayName&gt; element

Używaj oprócz atrybutu name do oznaczania zasady w edytor proxy interfejsu zarządzania z inną nazwą w języku naturalnym.

<DisplayName>Policy Display Name</DisplayName>
Domyślny

Nie dotyczy

Jeśli pominiesz ten element, atrybut name zasady otrzyma wartość .
Obecność Opcjonalnie
Typ Ciąg znaków

&lt;ResourceURL&gt; element

Ten element określa główny plik Pythona, który zostanie uruchomiony w przepływie interfejsu API. Możesz przechowywać ten plik w zakresie serwera proxy interfejsu API (w sekcji /apiproxy/resources/py na serwerze proxy API pakietu lub w sekcji Skrypty w panelu Nawigator edytora serwera proxy API bądź na stronie zakresy organizacji lub środowiska do ponownego wykorzystania na wielu serwerach proxy interfejsu API, jak opisano w Pliki zasobów. W Twoim kodzie może być używana sekcja obiekty, metody i właściwości obiektowego modelu JavaScript.

<ResourceURL>py://myscript.py</ResourceURL>
Domyślne: Brak
Obecność: Wymagane
Typ: Ciąg znaków

&lt;IncludeURL&gt; element

Określa plik Pythona do załadowania jako zależności od głównego pliku Pythona określonego za pomocą metody <ResourceURL> element. Skrypty zostaną ocenione w kolejności, w której są wymienione w zasadach.

Uwzględnij więcej niż jeden zasób zależności Pythona z dodatkowymi <IncludeURL> elementów.

<IncludeURL>py://myscript_dependency.py</IncludeURL>
Domyślne: Brak
Obecność: Opcjonalnie
Typ: Ciąg znaków

Kody błędów

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>

Powiązane artykuły