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

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

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

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

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

ویدیوی 5 دقیقه ای زیر نحوه ایجاد و ردیابی یک جریان مشترک در رابط کاربری Classic Edge (فقط Edge برای Private Cloud) را نشان می دهد.

می توانید با استفاده از خط مشی 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 است. برای اطلاعات بیشتر به استقرار پراکسی های API با استفاده از 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 را به پروکسی یا جریان مشترکی که آن را مصرف می کند اضافه می کنید. مانند یک خط مشی Callout Service که با آن به سرویس دیگری فراخوانی می کنید، 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، ردیابی پراکسی API را شروع کنید.
    3. یک درخواست به یک نقطه پایانی پروکسی در پراکسی API ارسال کنید. جریان از نقطه پایانی باید شامل خط مشی FlowCallout باشد که جریان مشترک را فراخوانی می کند.
    4. در تب Trace ، جریان از پروکسی API به جریان مشترک را بررسی کنید.

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

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

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

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

    لبه

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

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

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

    3. Develop > Shared Flows را در نوار پیمایش سمت چپ انتخاب کنید.

    Classic Edge (ابر خصوصی)

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

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

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

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

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

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

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

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

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

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

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

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

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

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