خط مشی PythonScript

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

چی

خط مشی Python Script به شما امکان می دهد عملکرد Python سفارشی شده را به جریان پروکسی API خود اضافه کنید، به خصوص زمانی که عملکرد مورد نیاز شما فراتر از آن چیزی است که خط مشی های خارج از جعبه Edge ارائه می کنند.

پشتیبانی از زبان پایتون از طریق Jython نسخه 2.5.2 ارائه می شود. کتابخانه های شخص ثالثی که اضافه می کنید باید "Pure Python" باشند (فقط در Python پیاده سازی شده است). برای اطلاعات بیشتر در مورد افزودن کتابخانه ها، فایل های منابع را ببینید.

یک خط مشی پایتون حاوی هیچ کد واقعی نیست. در عوض، یک خط مشی پایتون به یک منبع پایتون ارجاع می دهد و مرحله را در جریان API که در آن اسکریپت پایتون اجرا می شود، تعریف می کند. می‌توانید اسکریپت خود را از طریق ویرایشگر پروکسی مدیریت رابط کاربری آپلود کنید، یا می‌توانید آن را در فهرست /resources/py در پراکسی‌های API که به صورت محلی توسعه می‌دهید قرار دهید.

نمونه ها

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

مرجع عنصر

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

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

عنصر <DisplayName>

علاوه بر ویژگی name برای برچسب‌گذاری خط‌مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و به زبان طبیعی، از آن استفاده کنید.

<DisplayName>Policy Display Name</DisplayName>

عنصر <ResourceURL>

این عنصر فایل اصلی پایتون را مشخص می کند که در جریان API اجرا می شود. می‌توانید این فایل را در محدوده پروکسی API (در زیر /apiproxy/resources/py در بسته پراکسی API یا در بخش اسکریپت‌ها در پنجره ناوبر ویرایشگر پراکسی API)، یا در محدوده سازمان یا محیط برای استفاده مجدد در چندین پراکسی API ذخیره کنید. همانطور که در فایل های منابع توضیح داده شده است. کد شما می تواند از اشیاء، روش ها و ویژگی های مدل شی جاوا اسکریپت استفاده کند.

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

عنصر <IncludeURL>

یک فایل پایتون را مشخص می کند که به عنوان وابستگی به فایل اصلی پایتون مشخص شده با عنصر <ResourceURL> بارگذاری شود. اسکریپت ها به ترتیبی که در خط مشی فهرست شده اند ارزیابی می شوند.

بیش از یک منبع وابستگی پایتون را با عناصر <IncludeURL> اضافه کنید.

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

کدهای خطا

این بخش کدهای خطا و پیام‌های خطایی را که برگردانده می‌شوند و متغیرهای خطا را که توسط Edge تنظیم می‌شوند، هنگامی که این خط‌مشی خطا را راه‌اندازی می‌کند، توضیح می‌دهد. این اطلاعات برای دانستن اینکه آیا در حال توسعه قوانین خطا برای رسیدگی به خطاها هستید، مهم است. برای کسب اطلاعات بیشتر، آنچه را که باید در مورد خطاهای خط مشی و مدیریت خطاها بدانید را ببینید.

خطاهای زمان اجرا

این خطاها ممکن است هنگام اجرای سیاست رخ دهند.

خطاهای استقرار

این خطاها ممکن است زمانی رخ دهند که یک پروکسی حاوی این خط مشی را مستقر می کنید.

متغیرهای خطا

این متغیرها زمانی تنظیم می شوند که این خط مشی خطایی را در زمان اجرا ایجاد کند. برای اطلاعات بیشتر، به آنچه باید در مورد خطاهای خط مشی بدانید مراجعه کنید.

نمونه پاسخ خطا

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

مثال قانون خطا

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

موضوعات مرتبط