مرحله ۳: استفاده از خط‌مشی «افزونه‌ تماس»

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

هنگام توسعه یک پراکسی API، می‌توانید با افزودن یک خط‌مشی ExtensionCallout به پراکسی، از افزونه پشتیبانی کنید. (اگر برای ایجاد یک پراکسی ساده به کمک نیاز دارید، به ساخت اولین پراکسی مراجعه کنید.)

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

برای افزودن افزونه به پراکسی API:

  1. کارگزار نیابتی API خود را در کنسول Apigee Edge، در نمای توسعه باز کنید.

    اگرچه برای ایجاد افزونه باید سرپرست سازمان باشید، هر نقش کاربری می‌تواند افزونه را به پراکسی API اضافه کند.

  2. در قاب پیمایشگر، PreFlow را انتخاب کنید.

  3. در گوشه بالا سمت چپ، روی دکمه + مرحله کلیک کنید تا خط‌مشی اضافه کنید.

  4. در کادر گفتگوی افزودن مرحله، در فهرست خط‌مشی در سمت راست، روی «نوشته راهنمای افزونه» کلیک کنید.

    اگر خط‌مشی «توضیحات تماس افزونه» را در فهرست نمی‌بینید، مطمئن شوید که از واسط کاربر جدید Edge استفاده می‌کنید. علاوه‌براین، «افزونه‌های Apigee» درحال‌حاضر فقط برای مشتریان «سازمانی» Apigee Edge Cloud دردسترس است.

  5. در قاب سمت چپ، گزینه‌هایی را برای پیکربندی خط‌مشی انتخاب کنید:
    فیلد شرح
    نام نمایشی نام نمایشی خط‌مشی را وارد کنید.
    نام نامی را که می‌خواهید به‌صورت برنامه‌ریزی‌شده برای خط‌مشی استفاده شود وارد کنید. این مورد باید در پراکسی منحصربه‌فرد باشد.
    افزونه افزونه‌ای را برای استفاده انتخاب کنید. این افزونه‌ای است که قبلاً پیکربندی کرده‌اید.
    کنش‌ها کنش «گزارش» را انتخاب کنید.
  6. روی افزودن کلیک کنید.
  7. در نمای جریان، روی خط‌مشی کلیک کنید تا XML پیکربندی آن را مشاهده کنید.

    وقتی افزونه را اضافه می‌کنید، XML خط‌مشی نمونه دریافت خواهید کرد. توجه داشته باشید که این شامل طرحواره‌ای است که نحوه ساختاربندی پیکربندی برای عنصر <Input> را توصیف می‌کند. (می‌توانید طرحواره عنصر <Output> را نادیده بگیرید -- کنش افزونه «گزارش» بدنه پاسخی برنمی‌گرداند.)

  8. «زبان نشانه‌گذاری توسعه‌پذیر» خط‌مشی‌تان را ویرایش کنید تا شبیه به موارد زیر شود:
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Extension-Callout-Beta-1">
      <DisplayName>Logging Extension</DisplayName>
      <Connector>my-logging-extension</Connector>
      <Action>log</Action>
      <Input>{
        "logName": "example-log",
        "metadata": {
          "resource": {
            "type": "global",
            "labels": {
              "project_id": "my-gcp-project"
            }
          }
        },
        "message": "This is a test"
      }</Input>
    </ConnectorCallout><!--
    Input JSON Schema for package=gcp-stackdriver-logging version=0.0.4
    {"type":"object","properties":{"logName":{"type":"string"},"metadata":{"type":"string"},"message":{"type":"string"}},"required":["logName","message"]}
    -->
    <!--
    Output JSON Schema for package=gcp-stackdriver-logging version=0.0.4
    {"type":"object","properties":{"content":{"type":"string"}},"required":[]}
    -->

    در اینجا، <Input> موارد زیر را تعریف می‌کند:

    • ‫logName نام گزارشی است که باید در آن نوشته شود. اگر این مورد وجود نداشته باشد، افزونه آن را ایجاد خواهد کرد.
    • metadata اطلاعاتی را مشخص می‌کند که می‌توانید از آن برای مرور گزارش در کنسول Stackdriver استفاده کنید.
    • message صرفاً پیام گزارشی است که می‌خواهید بنویسید.
  9. روی دکمه ذخیره کردن کلیک کنید.

مرحله بعدی

مرحله ۱ مرحله ۲ مرحله ۳ مرحله ۴: استقرار پراکسی مرحله ۵