جریان‌های مشترک بازکاربردپذیر

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

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

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

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

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

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

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

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

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

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

درحال توسعه دادن یک جاری‌سازی مشترک

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

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

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

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

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

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

    برای مثال، به‌عنوان بخشی از پشتیبانی مدیریت ترافیک، ممکن است خط‌مشی «مهار جهش» را پیاده‌سازی کنید تا فقط ۳۰ درخواست در ثانیه مجاز باشد، مانند مثال زیر:

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

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

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

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

    همانند پراکسی‌های API، می‌توانید فایل zip حاوی منابع جاری مشترک خود را وارد کنید (برای اطلاعات بیشتر درباره وارد کردن پراکسی‌ها، به وارد کردن پراکسی جدید 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 مدیریت آمده است:

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

    در کد زیر، خط‌مشی 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. برای شروع استفاده از پراکسی میانای برنامه‌سازی کاربردی مصرف‌کننده، پراکسی میانای برنامه‌سازی کاربردی مصرف‌کننده را مستقر کنید. (برای اطلاعات بیشتر درباره استقرار به‌طور کلی، درک استقرار را ببینید.)
  6. با ردیابی، همان‌طور که با پراکسی میانای برنامه‌سازی کاربردی انجام می‌دهید، به‌صورت تکراری توسعه دهید.

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

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

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

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

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

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

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

    Edge

    برای دسترسی به صفحه «جریان‌های مشترک» بااستفاده از «واسط کاربر Edge»:

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

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

    3. در نوار پیمایش سمت راست، توسعه > جریان‌های مشترک را انتخاب کنید.

    میانای کاربر Edge جدید (ابر خصوصی)

    برای دسترسی به صفحه «جریان‌های مشترک» بااستفاده از «واسط کاربر Edge جدید»:

    1. در http://host:3001/edge به سیستم «میانای کاربر Edge جدید» وارد شوید. در اینجا، host نشانی IP یا نام ساناد میزبان اجرای «میانای کاربر Edge جدید» است.
    2. سازمانی را که حاوی جریان هم‌رسانی‌شده شما است انتخاب کنید. به جابه‌جایی بین سازمان‌ها مراجعه کنید.

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

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

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

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

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

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

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

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

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

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

همچنین مراجعه کنید به

زنجیر کردن پراکسی‌های میانای برنامه‌سازی کاربردی با یکدیگر