باز کردن پتانسیل API در 7 مرحله: Master RedHat 3-Scale برای مبتدیان

Summarize this content to 400 words in Persian Lang
باز کردن قدرت API ها: راهنمای مبتدیان

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

رابط برنامه نویسی کاربردی

تسلط بر مدیریت API

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

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

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

نقش دروازه های API

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

از اینجا، اسناد API را می توان منتشر کرد و داده ها را می توان برای تولید گزارش در صورت نیاز تجزیه و تحلیل کرد.

دروازه API

RedHat 3-Scale API Management

RedHat 3-scale API Management زیرساخت جامع API را فراهم می‌کند و به کاربران اجازه می‌دهد تا API‌ها را به اشتراک بگذارند، ایمن کنند، توزیع کنند، کنترل کنند و کسب درآمد کنند در یک پلتفرم با عملکرد بالا که برای کنترل مشتری و رشد آینده طراحی شده است. (منبع: www.redhat.com)

شروع به کار با API Onboarding

قبل از نصب هر API، ضروری است که پیش نیازهای زیر را برای اطمینان از یک فرآیند روان داشته باشید:

راه اندازی Openshift کامل شد.
سرویس مدیریت API 3scale در همان نمونه Openshift در دسترس است.
جزئیات API زیر در دسترس است:

نشانی وب سرویس کار.
روش ها (POST/GET).
مشخصات REST/SOAP.
داده های درخواست-پاسخ برای آزمایش.
تأیید دسترسی به سرویس از محیط.
تصمیمات برنامه های کاربردی (برنامه های کاربردی باید در سطح جهانی تصمیم گیری شوند، به عنوان مثال، سطح 3 مقیاس).

با پیروی از این دستورالعمل‌ها، می‌توانید از تجربه نصب یکپارچه API اطمینان حاصل کنید و پتانسیل کامل APIهای خود را باز کنید.
مثال گویا در این سند
آدرس اینترنتی: http://10.2.3.4:80/app/apiname

روش: ارسال

ایجاد مسیرهای مرحله‌بندی و تولید دروازه API

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

این دروازه‌ها اساساً به‌عنوان مسیرهای APICAST عمل می‌کنند و ما را قادر می‌سازند تا جریان ترافیک را به API شما که در یک نمونه خاص APICAST میزبانی شده است، تنظیم کنیم.

برای درک جامع APICAST، لطفاً به https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.3/html/deployment_options/apicast-overview مراجعه کنید.

پیکربندی یک Backend

یک Backend راه اندازی کنید.
این باطن نشان دهنده دامنه و پورت API است که می تواند توسط دو یا چند محصول به اشتراک گذاشته شود.
این نشانی وب پوشانده می‌شود و یک نشانی وب در 3 مقیاس برای دسترسی به این API در پست ورودی ارائه می‌شود.

در این مثال، ما URL پایه را به صورت زیر در نظر می گیریم: http://10.2.3.4:80/app.

پیکربندی یک محصول

یک محصول مسیر دقیقی است که دقیقاً سرویس API را مشخص می کند که ما قصد داریم روی آن نصب و نظارت کنیم.

پس از ایجاد محصول، می توانید به آن بروید ادغام -> تنظیمات برای دسترسی به جزئیات پیکربندی برای استقرار، احراز هویت و پاسخ های دروازه.

نشانی‌های اینترنتی مرحله‌بندی و تولید، نام مسیرهای سرویس را نشان می‌دهند.

توجه داشته باشید: نشانی‌های وب مرحله‌بندی و پایه تولید را فقط در صورتی می‌توان پیکربندی کرد که نام زیر دامنه بدون تغییر باقی بماند.

مکانیسم های احراز هویت

در مقیاس 3، احراز هویت API را می توان از طریق سه روش متمایز به دست آورد که در زیر به آنها اشاره شده است:

کلید API (user_key) برنامه از طریق یک رشته شناسایی و احراز هویت می شود.
App_ID و App_Key جفت برنامه از طریق App_ID شناسایی و از طریق App_Key احراز هویت می شود.
OpenID Connect برای هر جریان OAuth 2.0 از OpenID Connect استفاده کنید.

ما می توانیم درک عمیق تری از مکانیسم احراز هویت از لینک زیر به دست آوریم: https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.1/html-single/api_authentication/index

محل اعتبار احراز هویت

در این قسمت می توانید مشخص کنید که در درخواست ورودی، اعتبار احراز هویت مورد نیاز برای تایید را به کجا ارسال کنید.

پیکربندی یک روش

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

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

حرکت به محصول -> یکپارچه سازی -> روش و معیارها -> روش جدید.

برای شمارش دقیق تماس‌های خاص به API شما، یک روش باید به یک یا چند الگوی URL در بخش قوانین نقشه‌برداری صفحه ادغام پیوند داده شود.

پیکربندی معیارها

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

حرکت به محصول -> یکپارچه سازی -> روش و معیارها -> معیارهای جدید.

تعریف قوانین نقشه برداری

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

پیکربندی یک برنامه کاربردی برای یک محصول

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

محصول پیکربندی شده نیاز به یک برنامه کاربردی دارد که برای مدیریت اشتراک‌های حساب‌ها و برنامه‌های کاربردی آن‌ها در API طراحی شده است.

درک تمایز بین روش و معیارها

روش

روش ها مختص URL های خاص هستند. افزایش بازدیدها برای روش‌های تطبیق مسیر با فراخوانی API مدیریت خدمات در مقیاس 3 اتفاق می‌افتد.

معیارها

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

این معیار لزوماً به URL نیاز ندارد. یک نام ساده مبتنی بر رشته کافی است.

استقرار API

هنگامی که تمام تنظیمات کامل شد، باید API را در محیط های مرحله بندی و تولید مستقر کنیم.

حرکت به محصول -> یکپارچه سازی -> پیکربندی -> پیکربندی APIcast -> ارتقاء به مرحله بندی. (قبل از تبلیغ تمام تنظیمات موجود در این بخش را بررسی کنید)
پس از ارتقای موفقیت آمیز API از مرحله به مرحله تولید، صفحه بعدی نقاط پایانی را نشان می دهد که با مقیاس 3 برای تعامل با این APIها قابل دسترسی هستند.

نقاط دسترسی API با 3 مقیاس در معرض دید قرار می گیرند

پیکربندی تنظیمات حساب
مصرف کننده API شما به عنوان یک حساب مجزا ایجاد می شود.

به عنوان مثال، ما حساب زیر را راه اندازی کرده ایم:

ایجاد یک حساب کاربری جدید

یک کاربر در طول فرآیند راه اندازی حساب اضافه می شود و کاربران بیشتری را می توان از طریق ایمیل از صفحه زیر دعوت کرد.

مدیریت تنظیمات حساب کاربری

( توجه داشته باشید: این نیاز به راه اندازی SMTP در Openshift برای پروژه 3 مقیاسی دارد)

مدیریت کاربر از صفحه زیر قابل دسترسی است:

مدیریت کاربر

APIهای موجود در مقیاس 3 به عنوان برنامه در دسترس یک حساب کاربری قرار خواهند گرفت.

تنظیمات برنامه به شرح زیر است، جایی که می‌توانیم بخشی با عنوان “API Credentials” را مشاهده کنیم. کلید ارائه شده برای احراز هویت حساب و اجازه ادامه درخواست استفاده می شود.

دریافت اعتبار API

به هر برنامه‌ای که برای یک حساب راه‌اندازی می‌شود، یک شناسه منحصربه‌فرد اختصاص داده می‌شود.

برنامه های قابل دسترسی به یک حساب را می توان از طریق برگه اشتراک ها کنترل کرد، همانطور که در زیر نشان داده شده است، جایی که یک مدیر مدیریت API می تواند جزئیات طرح و اشتراک را تغییر دهد.

(نکته مهم: اگر یک حساب به یک طرح پیش‌فرض مرتبط باشد، نمی‌توان اشتراک آن را لغو کرد، زیرا API آن طرح را به عنوان پیکربندی پیش‌فرض برای همه کاربران تعیین کرده است)

API Gateway Hub

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

REST API می‌تواند مستندات جامع Swagger را در این پورتال منتشر کند و دسترسی فوری به اسناد دقیق را برای مشترکین فراهم کند که درک عمیق‌تر API مصرف‌کننده را تسهیل می‌کند.