خط‌مشی PythonScript

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

چه

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

پشتیبانی از زبان Python ازطریق Jython نسخه ۲.۵.۲ ارائه می‌شود. کتابخانه‌های طرف سومی که اضافه می‌کنید باید «Python خالص» باشند (فقط در Python پیاده‌سازی شده باشند). برای اطلاعات بیشتر درباره افزودن کتابخانه‌ها، فایل‌های منبع را ببینید.

خط‌مشی Python حاوی کد واقعی نیست. درعوض، خط‌مشی Python به منبع Python ارجاع می‌دهد و «مرحله» را در جریان میانای برنامه‌سازی کاربردی که در آن دستورگان Python اجرا می‌شود تعریف می‌کند. می‌توانید برنامه خود را ازطریق ویرایشگر پراکسی «واسط کاربر مدیریت» بارگذاری کنید، یا می‌توانید آن را در /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>

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

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

عنصر<IncludeURL>

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

بیش‌از یک منبع وابستگی Python با عناصر <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>

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