سياسة PythonScript

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

الأدوات المستخدمة

تتيح لك سياسة "نص Python البرمجي" إضافة وظائف مخصّصة بلغة Python إلى مسار خادم وكيل واجهة برمجة التطبيقات، خاصةً عندما تكون الوظائف التي تحتاج إليها تتجاوز ما توفّره السياسات الجاهزة في Edge

يتم توفير دعم لغة Python من خلال Jython الإصدار 2.5.2. يجب أن تكون مكتبات الجهات الخارجية التي تضيفها "Python خالصة" (تم تنفيذها بلغة Python فقط). لمزيد من المعلومات حول إضافة المكتبات، يُرجى الاطّلاع على ملفات الموارد.

لا تحتوي سياسة Python على أي رمز فعلي. بدلاً من ذلك، تشير سياسة Python إلى مورد Python وتحدّد الخطوة في مسار واجهة برمجة التطبيقات التي يتم فيها تنفيذ نص Python البرمجي. يمكنك تحميل النص البرمجي من خلال محرِّر الخادم الوكيل في واجهة الإدارة، أو يمكنك تضمينه في الدليل /resources/py في خوادم وكيل واجهة برمجة التطبيقات التي تطوّرها محليًا.

نماذج

<?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 الرئيسي الذي سيتم تنفيذه في مسار واجهة برمجة التطبيقات. يمكنك تخزين هذا الملف على مستوى خادم وكيل واجهة برمجة التطبيقات (ضمن /apiproxy/resources/py في حزمة خادم وكيل واجهة برمجة التطبيقات أو في قسم "النصوص البرمجية" في لوحة "المتصفح" في محرِّر خادم وكيل واجهة برمجة التطبيقات)، أو على مستوى المؤسسة أو البيئة لإعادة استخدامه في عدة خوادم وكيل لواجهة برمجة التطبيقات، كما هو موضّح في ملفات الموارد. يمكن أن يستخدم الرمز البرمجي الكائنات والطرق والسمات الخاصة بنموذج كائن JavaScript.

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

مواضيع ذات صلة