جریان های مشترک قابل استفاده مجدد

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

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

با جمع‌آوری قابلیت‌هایی که در چندین مکان مفید هستند، یک جریان مشترک به شما کمک می‌کند تا از ثبات، کاهش زمان توسعه و مدیریت آسان‌تر کد اطمینان حاصل کنید.

ویدیوی زیر نحوه ایجاد و ردیابی یک جریان مشترک در رابط کاربری Edge را نشان می‌دهد.

ویدیوی ۵ دقیقه‌ای زیر نحوه ایجاد و ردیابی یک جریان مشترک در رابط کاربری کلاسیک اج (اج فقط برای فضای ابری خصوصی) را نشان می‌دهد.

شما می‌توانید با استفاده از سیاست FlowCallout یک جریان مشترک را فراخوانی کنید. همچنین، با اتصال یک جریان مشترک به یک هوک جریان ، می‌توانید جریان مشترک را قبل از درخواست پروکسی یا هدف یا بعد از پاسخ پروکسی یا هدف اجرا کنید.

برای مرجع در مورد سیاست FlowCallout، به سیاست FlowCallout مراجعه کنید. برای اطلاعات بیشتر در مورد قلاب‌های جریان، به پیوست کردن یک جریان مشترک با استفاده از قلاب جریان مراجعه کنید.

برای مثال، تصور کنید حوزه‌هایی از عملکرد دارید که یا در چندین مکان استفاده می‌شوند یا باید در APIهای سازمان شما استانداردسازی شوند. می‌توانید برای هر دسته یک جریان مشترک داشته باشید، از جمله:

  • امنیت ، با کد مجوز با استفاده از تأیید کلید OAuth و API، و همچنین کد محافظت در برابر تهدید.
  • ثبت وقایع ، برای تولید پیام‌های خطای استاندارد.
  • میانجیگری ، برای تبدیل بین قالب‌های پیام XML و JSON.

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

توسعه یک جریان مشترک

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

در اینجا مراحل سطح بالا برای توسعه یک جریان مشترک آمده است:

  1. مشخص کنید که مجموعه ویژگی‌های مشترک باید چه باشند.

    برای مثال، ممکن است بخواهید ویژگی‌های مدیریت ترافیک، از جمله سرکوب افزایش ناگهانی ترافیک را با هم ترکیب کنید. به این ترتیب، می‌توانید پیکربندی آنها را خارج از گردش کار کسانی که منطق خط کسب‌وکار را پیاده‌سازی می‌کنند، مدیریت کنید.

  2. با پیاده‌سازی سیاست‌ها و پشتیبانی از منابع، یک جریان مشترک ایجاد کنید ، درست همانطور که هنگام توسعه یک پروکسی API این کار را انجام می‌دهید.

    یک جریان مشترک، دنباله‌ای از مراحل شرطی است. بنابراین توسعه‌ی آن مانند توسعه‌ی یک پروکسی API است. می‌توانید سیاست‌ها و منابعی را که ممکن است در یک پروکسی قرار دهید، در آن بگنجانید.

    برای مثال، به عنوان بخشی از پشتیبانی مدیریت ترافیک خود، می‌توانید یک سیاست Spike Arrest پیاده‌سازی کنید تا فقط 30 درخواست در ثانیه مجاز باشد، مانند مثال زیر:

    <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
    <DisplayName>Spike Arrest</DisplayName>
    <Properties/>
    <Identifier ref="request.header.some-header-name"/>
    <MessageWeight ref="request.header.weight"/>
    <Rate>30ps</Rate>
</SpikeArrest>

    سپس، به یک جریان مشترک برای مدیریت ترافیک، می‌توانید سیاست Spike Arrest را به عنوان یک مرحله پیوست کنید. این سیاست برای هر پروکسی API که جریان مشترک را فراخوانی می‌کند، اجرا می‌شود.

    <SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
</SharedFlow>

    برای اطلاعات در مورد نحوه شروع یک جریان مشترک در کنسول مدیریت، به ایجاد یک جریان مشترک در رابط کاربری Edge مراجعه کنید.

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

    curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \
-u email:password
  3. قبل از استقرار پروکسی‌ها یا جریان‌های مشترکی که آن را مصرف می‌کنند، جریان مشترک را در محیط مستقر کنید . شما یک جریان مشترک را به همان روشی مستقر می‌کنید که یک پروکسی API را مستقر می‌کنید. (برای اطلاعات بیشتر، به نمای کلی استقرار مراجعه کنید.)

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

    شما می‌توانید یک جریان مشترک را با یک فراخوانی API مدیریتی مانند زیر مستقر کنید:

    curl -X POST --header "Content-Type: application/octet-stream" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \
-u email:password

    همچنین می‌توانید یک جریان مشترک مستقر در حال حاضر را بدون هیچ گونه خرابی جایگزین کنید. (این بسیار شبیه به پروکسی‌های API است. برای اطلاعات بیشتر به Deploy API proxies using the management API مراجعه کنید.) فرم درخواست با استفاده از API مدیریت به شرح زیر است:

    curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
-u email:password
  4. پروکسی API مصرفی را طوری توسعه دهید که بتواند جریان مشترک را به عنوان بخشی از جریان خودش فراخوانی کند.

    از یک پروکسی API، شما با استفاده از سیاست FlowCallout به یک جریان مشترک فراخوانی می‌شوید. (همچنین می‌توانید جریان مشترک را با استفاده از یک قلاب جریان به پروکسی متصل کنید، همانطور که در بخش « اتصال یک جریان مشترک با استفاده از قلاب جریان » توضیح داده شده است.) برای آموزش مقدماتی در مورد ایجاد یک پروکسی API، به «ساخت اولین پروکسی API خود » مراجعه کنید.

    برای مصرف یک جریان مشترک، یک سیاست FlowCallout را به پروکسی یا جریان مشترکی که آن را مصرف می‌کند، اضافه می‌کنید. مانند یک سیاست Service Callout که با آن سرویس دیگری را فراخوانی می‌کنید، یک FlowCallout جریان مشترک را فراخوانی می‌کند. پروکسی API مصرف‌کننده باید پس از جریان مشترک و در همان محیطی که جریان مشترک قرار دارد، مستقر شود. جریان مشترک باید زمانی که می‌خواهید فراخوانی آن را با استفاده از سیاست FlowCallout آزمایش کنید، در محل خود قرار داشته باشد.

    در کد زیر، یک سیاست FlowCallout یک جریان مشترک به نام traffic-management-shared فراخوانی می‌کند.

    <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
    <DisplayName>Traffic Management FlowCallout</DisplayName>
    <Properties/>
    <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
</FlowCallout>

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

  5. برای شروع استفاده از جریان مشترک ، پروکسی API مصرفی را مستقر کنید . (برای اطلاعات بیشتر در مورد استقرار به طور کلی، به درک استقرار مراجعه کنید.)
  6. با ردیابی، همانطور که با یک پروکسی API انجام می‌دهید، به صورت تکراری توسعه دهید.

    همانند یک پروکسی API، شما یک جریان مشترک را با فراخوانی و ردیابی مکرر تا زمانی که منطق مورد نظر خود را داشته باشید، توسعه می‌دهید. در این حالت، از آنجا که جریان مشترک به خودی خود اجرا نمی‌شود، شما یک نقطه پایانی پروکسی را فراخوانی کرده و پروکسی را ردیابی می‌کنید.

    مراحل به شرح زیر است:

    1. مطمئن شوید که هم جریان مشترک و هم پروکسی API که آن را با یک سیاست FlowCallout فراخوانی می‌کند، در یک سازمان و در یک محیط مستقر هستند.
    2. در تب Trace مربوط به API proxy، شروع به ردیابی API proxy کنید.
    3. یک درخواست به یک نقطه پایانی پروکسی در پروکسی API ارسال کنید. جریان از نقطه پایانی باید شامل سیاست FlowCallout باشد که جریان مشترک را فراخوانی می‌کند.
    4. در برگه Trace ، جریان را از پروکسی API به جریان مشترک بررسی کنید.

      توجه داشته باشید که در ردیابی، جریان مشترک به صورت مجموعه‌ای از مراحل یا سیاست‌ها که در یک کادر خاکستری محصور شده‌اند، نمایش داده می‌شود. آیکون‌هایی که سیاست‌های FlowCallout را نشان می‌دهند، قبل از جریان‌های مشترک قرار می‌گیرند. (برای اطلاعات بیشتر در مورد ردیابی، به استفاده از ابزار ردیابی مراجعه کنید.)

ایجاد یک جریان مشترک در رابط کاربری Edge

وقتی از رابط کاربری Apigee Edge برای ایجاد یک جریان مشترک استفاده می‌کنید، می‌توانید آن را از ابتدا ایجاد کنید یا منابع جریان موجود را به عنوان یک فایل فشرده .zip وارد کنید.

  1. همانطور که در زیر توضیح داده شده است، به صفحه جریان‌های مشترک دسترسی پیدا کنید. در صفحه جریان‌های مشترک، می‌توانید لیستی از جریان‌های مشترک در سازمان را مشاهده کرده و جریان‌های موجود در لیست را ویرایش یا حذف کنید.

    لبه

    برای دسترسی به صفحه Shared Flows با استفاده از رابط کاربری Edge:

    1. وارد apigee.com/edge شوید.
    2. سازمانی که جریان اشتراکی شما در آن قرار دارد را انتخاب کنید. به بخش جابجایی بین سازمان‌هایتان مراجعه کنید.

      این جریان مشترک برای هر پروکسی API و جریان‌های مشترکی که در محیطی از این سازمان مستقر شده‌اند، در دسترس خواهد بود. اما از خارج از این سازمان در دسترس نخواهد بود.

    3. در نوار ناوبری سمت چپ، گزینه‌ی Develop > Shared Flows را انتخاب کنید.

    لبه کلاسیک (ابر خصوصی)

    برای دسترسی به صفحه Shared Flows با استفاده از رابط کاربری کلاسیک اج:

    1. وارد آدرس http:// ms-ip :9000 شوید، که در آن ms-ip آدرس IP یا نام DNS گره سرور مدیریت است.
    2. سازمانی که جریان اشتراکی شما در آن قرار دارد را انتخاب کنید. به بخش جابجایی بین سازمان‌هایتان مراجعه کنید.

      این جریان مشترک برای هر پروکسی API و جریان‌های مشترکی که در محیطی از این سازمان مستقر شده‌اند، در دسترس خواهد بود. اما از خارج از این سازمان در دسترس نخواهد بود.

    3. در نوار ناوبری بالا، APIها > جریان‌های مشترک را انتخاب کنید.
  2. برای شروع افزودن یک جریان مشترک جدید، روی دکمه + Shared Flow کلیک کنید.
  3. در صفحه «ایجاد یک جریان مشترک» ، نحوه ایجاد جریان جدید را انتخاب کنید:
    • یک جریان جدید از ابتدا ایجاد کنید. شما قادر خواهید بود سیاست‌ها و منابع را به عنوان مراحلی در جریان پیکربندی کنید.
      1. جریان مشترک خالی را انتخاب کنید.
      2. یک مقدار نام وارد کنید. این نامی خواهد بود که پروکسی‌های API و سایر جریان‌های مشترک برای ارجاع به این جریان مشترک استفاده می‌کنند. این نام باید برای توسعه‌دهندگانی که از این جریان استفاده می‌کنند، توصیفی باشد.
      3. برای ارائه اطلاعات بیشتر در مورد عملکرد جریان، توضیحی وارد کنید.
      4. روی بعدی کلیک کنید.
      5. به صورت اختیاری، محیط‌هایی را که می‌خواهید جریان جدید در آنها مستقر شود، انتخاب کنید.

        برای مثال، اگر قرار است جریان مشترک را از پروکسی‌های API مستقر در محیط تست آزمایش کنید، جریان مشترک را برای تست مستقر کنید.

      6. برای ایجاد و استقرار جریان مشترک جدید در محیط(های) انتخابی شما، روی «ساخت و استقرار» کلیک کنید. اگر هیچ محیطی را انتخاب نکرده باشید، جریان مشترک ایجاد می‌شود، اما مستقر نمی‌شود.

    • با آپلود یک بسته جریان، یک جریان مشترک از منابع موجود ایجاد کنید.
      1. برای مشخص کردن یک فایل .zip حاوی مصنوعاتی که می‌خواهید در جریان جدید داشته باشید، گزینه Shared Flow Bundle را انتخاب کنید.

        یک بسته جریان مشترک شامل مصنوعات منبع یک جریان مشترک است. به عنوان مثال، اگر قرار باشد یک جریان مشترک را از رابط کاربری Edge دانلود کنید، یک فایل .zip با بسته جریان خواهید داشت.

      2. روی بعدی کلیک کنید.
      3. برای جستجوی فایل .zip حاوی منابع جریان اشتراکی که می‌خواهید وارد کنید، روی «انتخاب فایل» کلیک کنید.
      4. در کادر نام جریان مشترک ، نامی برای جریان وارد شده وارد کنید. این نامی خواهد بود که پروکسی‌های API و سایر جریان‌های مشترک برای ارجاع به این جریان مشترک استفاده می‌کنند. این نام باید برای توسعه‌دهندگانی که از جریان استفاده می‌کنند، توصیفی باشد.
      5. روی بعدی کلیک کنید.
      6. برای ساخت جریان جدید از منابعی که وارد می‌کنید، روی «ساخت» کلیک کنید.

فراخوانی یک جریان مشترک از یک پروکسی API یا جریان مشترک

شما می‌توانید با استفاده از سیاست FlowCallout، یک جریان مشترک را از یک پروکسی یا از یک جریان مشترک دیگر فراخوانی کنید.

  1. در رابط کاربری Edge، پروکسی یا جریان اشتراکی را که می‌خواهید از آن جریان اشتراکی دیگری را فراخوانی کنید، پیدا کنید.
  2. در ناوبر ، کنار سیاست‌ها ، روی دکمه + کلیک کنید.
  3. در فهرست سیاست‌ها، در زیر Extension ، روی FlowCallout کلیک کنید.
  4. نام نمایشی و نام (شناسه منحصر به فرد) را وارد کنید، سپس جریان مشترکی را که این خط‌مشی فراخوانی خواهد کرد، انتخاب کنید.
  5. روی افزودن کلیک کنید.
  6. خط‌مشی جدید FlowCallout را به پروکسی که می‌خواهید تماس در آن برقرار شود، اضافه کنید.

همچنین ببینید

اتصال زنجیره‌ای پروکسی‌های API به یکدیگر